Class API<T, U>

Type Parameters

T extends APIConfig = APIConfig
U = undefined

Hierarchy

API
- GraphQLAPI

Index

Constructors

Properties

baseURL config status

Methods

connect delete get handle handleError handlePending handleSuccess head isConfigStatusSettable onHandleStart options patch post put setCallStatus trace transformBody transformQueryParameters write

Constructors

constructor

new API<T, U>(baseURL?, config?): API<T, U>
Type Parameters
- T extends APIConfig<unknown> = APIConfig<unknown>
- U = undefined
Parameters
- baseURL: string = ''
- config: T = ...
Returns API<T, U>
- Defined in src/modules/api.ts:22

Properties

`Readonly` baseURL

baseURL: string

`Readonly` config

config: T

`Readonly` status

status: Status

Methods

connect

connect<V, W>(path, config?): Promise<FetchResponse<V> | FetchError<W>>
Type Parameters
- V
- W = U
Parameters
- path: string
- Optional config: T
Returns Promise<FetchResponse<V> | FetchError<W>>
- Defined in src/modules/api.ts:62

delete

delete<V, W>(path, config?): Promise<FetchResponse<V> | FetchError<W>>
Type Parameters
- V
- W = U
Parameters
- path: string
- Optional config: T
Returns Promise<FetchResponse<V> | FetchError<W>>
- Defined in src/modules/api.ts:66

get

get<V, W>(path, config?): Promise<FetchResponse<V> | FetchError<W>>
Type Parameters
- V
- W = U
Parameters
- path: string
- Optional config: T
Returns Promise<FetchResponse<V> | FetchError<W>>
- Defined in src/modules/api.ts:70

handle

handle<V, W, X>(method, path, body?, config?): Promise<FetchResponse<V> | FetchError<X>>
Type Parameters
- V
- W
- X = U
Parameters
- method: RequestMethod
- path: string
- Optional body: W
- config: T = ...
Returns Promise<FetchResponse<V> | FetchError<X>>
- Defined in src/modules/api.ts:30

handleError

handleError<V, W>(method, path, body, config, error): Promise<boolean>
Type Parameters
- V
- W = U
Parameters
- method: RequestMethod
- path: string
- body: undefined | V
- config: T
- error: FetchError<W>
Returns Promise<boolean>
- Defined in src/modules/api.ts:119

handlePending

handlePending<V>(method, path, body, config): Promise<boolean>
Type Parameters
- V
Parameters
- method: RequestMethod
- path: string
- body: undefined | V
- config: T
Returns Promise<boolean>
- Defined in src/modules/api.ts:123

handleSuccess

handleSuccess<V, W>(method, path, body, config, response): Promise<boolean>
Type Parameters
- V
- W
Parameters
- method: RequestMethod
- path: string
- body: undefined | W
- config: T
- response: FetchResponse<V>
Returns Promise<boolean>
- Defined in src/modules/api.ts:127

head

head(path, config?): Promise<FetchResponse<unknown> | FetchError<unknown>>
Parameters
- path: string
- Optional config: T
Returns Promise<FetchResponse<unknown> | FetchError<unknown>>
- Defined in src/modules/api.ts:74

`Private` isConfigStatusSettable

isConfigStatusSettable(config, status): boolean
Internal
Parameters
- config: APIConfig<unknown>
- status: string
Returns boolean
- Defined in src/modules/api.ts:139

`Protected` onHandleStart

onHandleStart(): Promise<void>
Returns Promise<void>
- Defined in src/modules/api.ts:28

options

options<V, W>(path, config?): Promise<FetchResponse<V> | FetchError<W>>
Type Parameters
- V
- W = U
Parameters
- path: string
- Optional config: T
Returns Promise<FetchResponse<V> | FetchError<W>>
- Defined in src/modules/api.ts:78

patch

patch<V, W, X>(path, body?, config?): Promise<FetchResponse<V> | FetchError<X>>
Type Parameters
- V
- W
- X = U
Parameters
- path: string
- Optional body: W
- Optional config: T
Returns Promise<FetchResponse<V> | FetchError<X>>
- Defined in src/modules/api.ts:82

post

post<V, W, X>(path, body?, config?): Promise<FetchResponse<V> | FetchError<X>>
Type Parameters
- V
- W
- X = U
Parameters
- path: string
- Optional body: W
- Optional config: T
Returns Promise<FetchResponse<V> | FetchError<X>>
- Defined in src/modules/api.ts:86

put

put<V, W, X>(path, body?, config?): Promise<FetchResponse<V> | FetchError<X>>
Type Parameters
- V
- W
- X = U
Parameters
- path: string
- Optional body: W
- Optional config: T
Returns Promise<FetchResponse<V> | FetchError<X>>
- Defined in src/modules/api.ts:90

`Private` setCallStatus

setCallStatus(method, path, config, status): void
Internal
Parameters
- method: RequestMethod
- path: string
- config: T
- status: string
Returns void
- Defined in src/modules/api.ts:132

trace

trace(path, config?): Promise<FetchResponse<unknown> | FetchError<unknown>>
Parameters
- path: string
- Optional config: T
Returns Promise<FetchResponse<unknown> | FetchError<unknown>>
- Defined in src/modules/api.ts:94

transformBody

transformBody<V>(method, path, body, config): Promise<any>
Type Parameters
- V
Parameters
- method: RequestMethod
- path: string
- body: undefined | V
- config: T
Returns Promise<any>
- Defined in src/modules/api.ts:107

transformQueryParameters

transformQueryParameters<V>(method, path, body, config): Promise<string>
Type Parameters
- V
Parameters
- method: RequestMethod
- path: string
- body: undefined | V
- config: T
Returns Promise<string>
- Defined in src/modules/api.ts:111

write

write<V, W, X>(mode, path, body?, config?): Promise<FetchResponse<V> | FetchError<X>>
Type Parameters
- V
- W
- X = U
Parameters
- mode: WriteMode
- path: string
- Optional body: W
- Optional config: T
Returns Promise<FetchResponse<V> | FetchError<X>>
- Defined in src/modules/api.ts:98

Generated using TypeDoc