Class GraphQLAPI<T, U>

Type Parameters

T extends GraphQLAPIConfig = GraphQLAPIConfig
U = undefined

Hierarchy

API<T, U>
- GraphQLAPI

Index

Constructors

Properties

baseURL config status

Methods

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

Constructors

constructor

new GraphQLAPI<T, U>(baseURL?, config?): GraphQLAPI<T, U>
Type Parameters
- T extends GraphQLAPIConfig<unknown> = GraphQLAPIConfig<unknown>
- U = undefined
Parameters
- Optional baseURL: string
- Optional config: T
Returns GraphQLAPI<T, U>
Overrides API.constructor
- Defined in src/modules/graphql-api.ts:10

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>>
Inherited from API.connect
- 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>>
Inherited from API.delete
- 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>>
Inherited from API.get
- 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>>
Inherited from API.handle
- 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>
Inherited from API.handleError
- 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>
Inherited from API.handlePending
- 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>
Inherited from API.handleSuccess
- 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>>
Inherited from API.head
- Defined in src/modules/api.ts:74

mutation

mutation<V, W, X>(mutation, variables?, config?): Promise<GraphQLAPIResponse<V> | FetchError<X>>
Type Parameters
- V
- W extends object
- X = U
Parameters
- mutation: string
- Optional variables: W
- Optional config: T
Returns Promise<GraphQLAPIResponse<V> | FetchError<X>>
- Defined in src/modules/graphql-api.ts:25

`Protected` onHandleStart

onHandleStart(): Promise<void>
Returns Promise<void>
Inherited from API.onHandleStart
- 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>>
Inherited from API.options
- 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>>
Inherited from API.patch
- Defined in src/modules/api.ts:82

post

post<V, W, X>(query, variables?, config?): Promise<FetchResponse<V> | FetchError<X>>
Type Parameters
- V
- W
- X = U
Parameters
- query: string
- Optional variables: W
- Optional config: T
Returns Promise<FetchResponse<V> | FetchError<X>>
Overrides API.post
- Defined in src/modules/graphql-api.ts:14

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>>
Inherited from API.put
- Defined in src/modules/api.ts:90

query

query<V, W, X>(query, variables?, config?): Promise<GraphQLAPIResponse<V> | FetchError<X>>
Type Parameters
- V
- W extends object
- X = U
Parameters
- query: string
- Optional variables: W
- Optional config: T
Returns Promise<GraphQLAPIResponse<V> | FetchError<X>>
- Defined in src/modules/graphql-api.ts:29

trace

trace(path, config?): Promise<FetchResponse<unknown> | FetchError<unknown>>
Parameters
- path: string
- Optional config: T
Returns Promise<FetchResponse<unknown> | FetchError<unknown>>
Inherited from API.trace
- 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>
Inherited from API.transformBody
- 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>
Inherited from API.transformQueryParameters
- 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>>
Inherited from API.write
- Defined in src/modules/api.ts:98

Generated using TypeDoc