Request | Streams Platform Client Api

Type parameters

T = any
D = any

Hierarchy

Request

Index

Constructors

constructor

Properties

Accessors

cancelToken

Methods

Constructors

Protected constructor

new Request<T, D>(config: RequestConfig<any>): Request<T, D>

- Defined in packages/@laravel-streams/api-client/src/Request.ts:30
Type parameters
- T = any
- D = any
Parameters
- config: RequestConfig<any>
Returns Request<T, D>

Properties

Protected CancelToken

CancelToken: CancelTokenStatic

Protected CancelTokenSource

CancelTokenSource: CancelTokenSource

config

config: RequestConfig<any>

Readonly hooks

hooks: { createAxios: SyncWaterfallHook<[AxiosInstance, Request<any, any>], UnsetAdditionalOptions>; response: SyncWaterfallHook<[Response<any, any>, RequestConfig<any>, Request<any, any>], UnsetAdditionalOptions>; send: AsyncSeriesWaterfallHook<[RequestConfig<any>, AxiosInstance, Request<any, any>], UnsetAdditionalOptions> } = ...

Type declaration

createAxios: SyncWaterfallHook<[AxiosInstance, Request<any, any>], UnsetAdditionalOptions>
response: SyncWaterfallHook<[Response<any, any>, RequestConfig<any>, Request<any, any>], UnsetAdditionalOptions>
send: AsyncSeriesWaterfallHook<[RequestConfig<any>, AxiosInstance, Request<any, any>], UnsetAdditionalOptions>

Accessors

cancelToken

get cancelToken(): CancelToken

- Defined in packages/@laravel-streams/api-client/src/Request.ts:28
Returns CancelToken

Methods

Accept

Accept(mime: string | number): Request<T, D>

- Defined in packages/@laravel-streams/api-client/src/Request.ts:86
Parameters
- mime: string | number
Returns Request<T, D>

ContentType

ContentType(mime: string | number): Request<T, D>

- Defined in packages/@laravel-streams/api-client/src/Request.ts:91
Parameters
- mime: string | number
Returns Request<T, D>

IfNoneMatch

IfNoneMatch(etag: string): Request<T, D>

- Defined in packages/@laravel-streams/api-client/src/Request.ts:96
Parameters
- etag: string
Returns Request<T, D>

authorization

authorization(key: "Basic" | "Bearer", value: string): Request<T, D>

- Defined in packages/@laravel-streams/api-client/src/Request.ts:109
Parameters
- key: "Basic" | "Bearer"
- value: string
Returns Request<T, D>

basic

basic(username: string, password: string): Request<T, D>

- Defined in packages/@laravel-streams/api-client/src/Request.ts:101
Parameters
- username: string
- password: string
Returns Request<T, D>

bearer

bearer(token: string): Request<T, D>

- Defined in packages/@laravel-streams/api-client/src/Request.ts:105
Parameters
- token: string
Returns Request<T, D>

cancel

cancel(message: string): Request<T, D>

- Defined in packages/@laravel-streams/api-client/src/Request.ts:76
Parameters
- message: string
Returns Request<T, D>

createAxios

createAxios(): AxiosInstance

- Defined in packages/@laravel-streams/api-client/src/Request.ts:65
Returns AxiosInstance

header

header(key: RequestHeader, value: any): Request<T, D>

- Defined in packages/@laravel-streams/api-client/src/Request.ts:81
Parameters
- key: RequestHeader
- value: any
Returns Request<T, D>

mergeConfig

mergeConfig(config: Partial<RequestConfig<any>>): Request<T, D>

- Defined in packages/@laravel-streams/api-client/src/Request.ts:71
Parameters
- config: Partial<RequestConfig<any>>
Returns Request<T, D>

send

send(config?: Partial<RequestConfig<any>>): Promise<Response<T, D>>

- Defined in packages/@laravel-streams/api-client/src/Request.ts:47
Parameters
- config: Partial<RequestConfig<any>> = {}
Returns Promise<Response<T, D>>

Static create

create<T, D>(config: RequestConfig<D>): Request<T, D>

- Defined in packages/@laravel-streams/api-client/src/Request.ts:43
Type parameters
- T = any
- D = any
Parameters
- config: RequestConfig<D>
Returns Request<T, D>

Type parameters

T = any

D = any

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Protected constructor

Type parameters

T = any

D = any

Parameters

config: RequestConfig<any>

Returns Request<T, D>

Properties

Protected CancelToken

Protected CancelTokenSource

config

Readonly hooks

Type declaration

createAxios: SyncWaterfallHook<[AxiosInstance, Request<any, any>], UnsetAdditionalOptions>

response: SyncWaterfallHook<[Response<any, any>, RequestConfig<any>, Request<any, any>], UnsetAdditionalOptions>

send: AsyncSeriesWaterfallHook<[RequestConfig<any>, AxiosInstance, Request<any, any>], UnsetAdditionalOptions>

Accessors

cancelToken

Returns CancelToken

Methods

Accept

Parameters

mime: string | number

Returns Request<T, D>

ContentType

Parameters

mime: string | number

Returns Request<T, D>

IfNoneMatch

Parameters

etag: string

Returns Request<T, D>

authorization

Parameters

key: "Basic" | "Bearer"

value: string

Returns Request<T, D>

basic

Parameters

username: string

password: string

Returns Request<T, D>

bearer

Parameters

token: string

Returns Request<T, D>

cancel

Parameters

message: string

Returns Request<T, D>

createAxios

Returns AxiosInstance

header

Parameters

key: RequestHeader

value: any

Returns Request<T, D>

mergeConfig

Parameters

config: Partial<RequestConfig<any>>

Returns Request<T, D>

send

Parameters

config: Partial<RequestConfig<any>> = {}

Returns Promise<Response<T, D>>

Static create

Type parameters

T = any

D = any

Parameters