FsRequest | filestack-js

Main isomorphic Filestack request library

export
class: FsRequest

Hierarchy

FsRequest

Index

Constructors

constructor

Methods

Constructors

constructor

new FsRequest(config?: FsRequestOptions): FsRequest

- Defined in src/lib/request/request.ts:54
Creates an instance of Request.

memberof

FsRequest

Parameters
- Optional config: FsRequestOptions
Returns FsRequest

Methods

dispatch

dispatch(config: FsRequestOptions): Promise<FsResponse>

- Defined in src/lib/request/request.ts:92
Run request with given adapter

memberof

Request

Parameters
- config: FsRequestOptions
Returns Promise<FsResponse>

Static delete

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

- Defined in src/lib/request/request.ts:174
Dispatch DELETE request

static

memberof

FsRequest

Parameters
- url: string
- Optional config: FsRequestOptions
Returns Promise<FsResponse>

Static dispatch

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

- Defined in src/lib/request/request.ts:109
Dispatch request

static

memberof

FsRequest

Parameters
- url: string
- config: FsRequestOptions
Returns Promise<FsResponse>

Static get

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

- Defined in src/lib/request/request.ts:122
Dispatch GET request

static

memberof

FsRequest

Parameters
- url: string
- Optional config: FsRequestOptions
Returns Promise<FsResponse>

Static head

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

- Defined in src/lib/request/request.ts:135
Dispatch HEAD request

static

memberof

FsRequest

Parameters
- url: string
- Optional config: FsRequestOptions
Returns Promise<FsResponse>

Static options

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

- Defined in src/lib/request/request.ts:148
Dispatch OPTIONS request

static

memberof

FsRequest

Parameters
- url: string
- Optional config: FsRequestOptions
Returns Promise<FsResponse>

Static path

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

- Defined in src/lib/request/request.ts:216
Dispatch PATCH request

static

memberof

FsRequest

Parameters
- url: string
- Optional data: any
- Optional config: FsRequestOptions
Returns Promise<FsResponse>

Static post

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

- Defined in src/lib/request/request.ts:188
Dispatch POST request

static

memberof

FsRequest

Parameters
- url: string
- Optional data: any
- Optional config: FsRequestOptions
Returns Promise<FsResponse>

Static purge

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

- Defined in src/lib/request/request.ts:161
Dispatch PURGE request

static

memberof

FsRequest

Parameters
- url: string
- Optional config: FsRequestOptions
Returns Promise<FsResponse>

Static put

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

- Defined in src/lib/request/request.ts:202
Dispatch PUT request

static

memberof

FsRequest

Parameters
- url: string
- Optional data: any
- Optional config: FsRequestOptions
Returns Promise<FsResponse>