Class FsRequest

Main isomorphic Filestack request library

Export

Hierarchy

FsRequest

Index

Constructors

Methods

dispatch delete dispatch get head options path post purge put

Constructors

constructor

new FsRequest(config?: FsRequestOptions): FsRequest
Creates an instance of Request.

Memberof
FsRequest
Parameters
- Optional config: FsRequestOptions
Returns FsRequest
- Defined in lib/request/request.ts:62

Methods

dispatch

dispatch(config: FsRequestOptions): Promise<FsResponse>
Run request with given adapter

Returns

Memberof
Request
Parameters
- config: FsRequestOptions
Returns Promise<FsResponse>
- Defined in lib/request/request.ts:92

`Static` delete

delete(url: string, config?: FsRequestOptions): Promise<FsResponse>
Dispatch DELETE request

Static

Returns

Memberof
FsRequest
Parameters
- url: string
- Optional config: FsRequestOptions
Returns Promise<FsResponse>
- Defined in lib/request/request.ts:174

`Static` dispatch

dispatch(url: string, config: FsRequestOptions): Promise<FsResponse>
Dispatch request

Static

Returns

Memberof
FsRequest
Parameters
- url: string
- config: FsRequestOptions
Returns Promise<FsResponse>
- Defined in lib/request/request.ts:109

`Static` get

get(url: string, config?: FsRequestOptions): Promise<FsResponse>
Dispatch GET request

Static

Returns

Memberof
FsRequest
Parameters
- url: string
- Optional config: FsRequestOptions
Returns Promise<FsResponse>
- Defined in lib/request/request.ts:122

`Static` head

head(url: string, config?: FsRequestOptions): Promise<FsResponse>
Dispatch HEAD request

Static

Returns

Memberof
FsRequest
Parameters
- url: string
- Optional config: FsRequestOptions
Returns Promise<FsResponse>
- Defined in lib/request/request.ts:135

`Static` options

options(url: string, config?: FsRequestOptions): Promise<FsResponse>
Dispatch OPTIONS request

Static

Returns

Memberof
FsRequest
Parameters
- url: string
- Optional config: FsRequestOptions
Returns Promise<FsResponse>
- Defined in lib/request/request.ts:148

`Static` path

path(url: string, data?: any, config?: FsRequestOptions): Promise<FsResponse>
Dispatch PATCH request

Static

Returns

Memberof
FsRequest
Parameters
- url: string
- Optional data: any
- Optional config: FsRequestOptions
Returns Promise<FsResponse>
- Defined in lib/request/request.ts:216

`Static` post

post(url: string, data?: any, config?: FsRequestOptions): Promise<FsResponse>
Dispatch POST request

Static

Returns

Memberof
FsRequest
Parameters
- url: string
- Optional data: any
- Optional config: FsRequestOptions
Returns Promise<FsResponse>
- Defined in lib/request/request.ts:188

`Static` purge

purge(url: string, config?: FsRequestOptions): Promise<FsResponse>
Dispatch PURGE request

Static

Returns

Memberof
FsRequest
Parameters
- url: string
- Optional config: FsRequestOptions
Returns Promise<FsResponse>
- Defined in lib/request/request.ts:161

`Static` put

put(url: string, data?: any, config?: FsRequestOptions): Promise<FsResponse>
Dispatch PUT request

Static

Returns

Memberof
FsRequest
Parameters
- url: string
- Optional data: any
- Optional config: FsRequestOptions
Returns Promise<FsResponse>
- Defined in lib/request/request.ts:202