Class Http

Hierarchy

Http

Index

Constructors

constructor

Properties

streams

Accessors

config

Methods

Constructors

constructor

new Http(streams: Streams): Http

- Defined in packages/@laravel-streams/api-client/src/Http.ts:8
Parameters
- streams: Streams
Returns Http

Properties

Protected streams

streams: Streams

Accessors

config

get config(): StreamsConfiguration

- Defined in packages/@laravel-streams/api-client/src/Http.ts:11
Returns StreamsConfiguration

Methods

deleteEntry

deleteEntry<ID, T, R>(stream: ID, entry: string | number, config?: RequestConfig<any>): Promise<Response<R, any>>

- Defined in packages/@laravel-streams/api-client/src/Http.ts:58
Type parameters
- ID: string | number
- T = any
- R = boolean
Parameters
- stream: ID
- entry: string | number
- config: RequestConfig<any> = {}
Returns Promise<Response<R, any>>

deleteStream

deleteStream(stream: string | number, config?: RequestConfig<any>): Promise<Response<boolean, any>>

- Defined in packages/@laravel-streams/api-client/src/Http.ts:33
Parameters
- stream: string | number
- config: RequestConfig<any> = {}
Returns Promise<Response<boolean, any>>

getEntries

getEntries<ID, T, R>(stream: ID, params?: any, config?: RequestConfig<any>): Promise<Response<R, any>>

- Defined in packages/@laravel-streams/api-client/src/Http.ts:38
Type parameters
- ID: string | number
- T = IEntries[ID]
- R = ApiDataResponse<T[], "entries", "list", Partial<Record<"stream" | "self" | "first_page" | "next_page" | "previous_page", string>>, any, ApiMeta<"list", any>>
Parameters
- stream: ID
- params: any = {}
- config: RequestConfig<any> = {}
Returns Promise<Response<R, any>>

getEntry

getEntry<ID, T, R>(stream: ID, entry: string | number, config?: RequestConfig<any>): Promise<Response<R, any>>

- Defined in packages/@laravel-streams/api-client/src/Http.ts:46
Type parameters
- ID: string | number
- T = IEntries[ID]
- R = ApiDataResponse<T, "entries", "get", Partial<Record<"stream" | "entries" | "self", string>>, any, ApiMeta<"get", any>>
Parameters
- stream: ID
- entry: string | number
- config: RequestConfig<any> = {}
Returns Promise<Response<R, any>>

getStream

getStream<ID, R>(stream: ID, params?: any, config?: RequestConfig<any>): Promise<Response<R, any>>

- Defined in packages/@laravel-streams/api-client/src/Http.ts:21
Type parameters
- ID: string | number
- R = ApiDataResponse<IStream<ID>, "streams", "get", Partial<Record<"stream" | "entries" | "self", string>>, any, ApiMeta<"get", any>>
Parameters
- stream: ID
- params: any = {}
- config: RequestConfig<any> = {}
Returns Promise<Response<R, any>>

getStreams

getStreams<T, R>(params?: any, config?: RequestConfig<any>): Promise<Response<R, any>>

- Defined in packages/@laravel-streams/api-client/src/Http.ts:13
Type parameters
- T = IBaseStream<any>[]
- R = ApiDataResponse<T, "streams", "list", Partial<Record<"stream" | "self" | "first_page" | "next_page" | "previous_page", string>>, any, ApiMeta<"list", any>>
Parameters
- params: any = {}
- config: RequestConfig<any> = {}
Returns Promise<Response<R, any>>

patchEntry

patchEntry<ID, T, R>(stream: ID, entry: string | number, data?: any, config?: RequestConfig<any>): Promise<Response<R, any>>

- Defined in packages/@laravel-streams/api-client/src/Http.ts:50
Type parameters
- ID: string | number
- T = IEntries[ID]
- R = ApiDataResponse<T, "entries", "patch", Partial<Record<"stream" | "entries" | "self" | "streams", string>>, any, ApiMeta<"patch", any>>
Parameters
- stream: ID
- entry: string | number
- data: any = {}
- config: RequestConfig<any> = {}
Returns Promise<Response<R, any>>

patchStream

patchStream<ID, R>(stream: ID, data?: any, config?: RequestConfig<any>): Promise<Response<R, any>>

- Defined in packages/@laravel-streams/api-client/src/Http.ts:25
Type parameters
- ID: string | number
- R = ApiDataResponse<IStream<ID>, "streams", "patch", Partial<Record<"stream" | "entries" | "self" | "streams", string>>, any, ApiMeta<"patch", any>>
Parameters
- stream: ID
- data: any = {}
- config: RequestConfig<any> = {}
Returns Promise<Response<R, any>>

postEntry

postEntry<ID, T, R>(stream: ID, data?: any, config?: RequestConfig<any>): Promise<Response<R, any>>

- Defined in packages/@laravel-streams/api-client/src/Http.ts:42
Type parameters
- ID: string | number
- T = IEntries[ID]
- R = ApiDataResponse<T, "entries", "post", Partial<Record<"stream" | "entries" | "self" | "location", string>>, any, ApiMeta<"post", any>>
Parameters
- stream: ID
- data: any = {}
- config: RequestConfig<any> = {}
Returns Promise<Response<R, any>>

postStream

postStream<T, R>(data: T, config?: RequestConfig<any>): Promise<Response<R, any>>

- Defined in packages/@laravel-streams/api-client/src/Http.ts:17
Type parameters
- T
- R = ApiDataResponse<IStreamPost<T, string | number>, "streams", "post", Partial<Record<"stream" | "entries" | "self" | "location", string>>, any, ApiMeta<"post", any>>
Parameters
- data: T
- config: RequestConfig<any> = {}
Returns Promise<Response<R, any>>

putEntry

putEntry<ID, T, R>(stream: ID, entry: string | number, data?: any, config?: RequestConfig<any>): Promise<Response<R, any>>

- Defined in packages/@laravel-streams/api-client/src/Http.ts:54
Type parameters
- ID: string | number
- T = IEntries[ID]
- R = ApiDataResponse<T, "entries", "put", Partial<Record<"stream" | "entries" | "self", string>>, any, ApiMeta<"put", any>>
Parameters
- stream: ID
- entry: string | number
- data: any = {}
- config: RequestConfig<any> = {}
Returns Promise<Response<R, any>>

putStream

putStream<ID, R>(stream: ID, data?: any, config?: RequestConfig<any>): Promise<Response<R, any>>

- Defined in packages/@laravel-streams/api-client/src/Http.ts:29
Type parameters
- ID: string | number
- R = ApiDataResponse<IStream<ID>, "streams", "put", Partial<Record<"stream" | "entries" | "self", string>>, any, ApiMeta<"put", any>>
Parameters
- stream: ID
- data: any = {}
- config: RequestConfig<any> = {}
Returns Promise<Response<R, any>>

Protected request

request<T, D>(method: Method, url: string, config?: RequestConfig<any>): Promise<Response<T, D>>
request<T, D>(method: Method, url: string, config: RequestConfig<any>, data: D): Promise<Response<T, D>>

- Defined in packages/@laravel-streams/api-client/src/Http.ts:62
Type parameters
- T = any
- D = any
Parameters
- method: Method
- url: string
- Optional config: RequestConfig<any>
Returns Promise<Response<T, D>>
- Defined in packages/@laravel-streams/api-client/src/Http.ts:63
Type parameters
- T = any
- D = any
Parameters
- method: Method
- url: string
- config: RequestConfig<any>
- data: D
Returns Promise<Response<T, D>>