Class GraphQlAPI<T, U>

The GraphQlAPI class extends the RestAPI class and manages the requests to a GraphQL API.

The base URL of the API is automatically concatenated to the path of the requests.
The config of the API is automatically merged with the config of the requests.
The status of the requests is automatically tracked and can be accessed through the status property.
The requests are sent with the Fetch class, so all features of the Fetch class are available.

Aracna Reference

Type Parameters

T extends GraphQlApiConfig = GraphQlApiConfig
U = undefined

Hierarchy (View Summary)

RestAPI<T, U>
- GraphQlAPI

Index

Constructors

constructor

new GraphQlAPI<
    T extends GraphQlApiConfig<unknown> = GraphQlApiConfig<unknown>,
    U = undefined,
>(
    baseURL?: string,
    config?: T,
): GraphQlAPI<T, U>
Type Parameters
- T extends GraphQlApiConfig<unknown> = GraphQlApiConfig<unknown>
- U = undefined
Parameters
- baseURL: string = ''
- config: T = ...
Returns GraphQlAPI<T, U>
Inherited from RestAPI.constructor
- Defined in src/classes/rest-api.ts:37

Properties

`Protected`baseURL

baseURL: string

The base URL of the REST API.

`Protected`config

config: T

The default config of the REST API.

`Readonly`status

status: Status

The status of the requests.

Methods

connect

connect<V, W = U>(
path: string,
config?: T,
): Promise<FetchResponse<V> | FetchError<W>>
Sends a CONNECT request to the REST API.
Type Parameters
- V
- W = U
Parameters
- path: string
- Optionalconfig: T
Returns Promise<FetchResponse<V> | FetchError<W>>
Inherited from RestAPI.connect
- Defined in src/classes/rest-api.ts:82

delete

delete<V, W = U>(
path: string,
config?: T,
): Promise<FetchResponse<V> | FetchError<W>>
Sends a DELETE request to the REST API.
Type Parameters
- V
- W = U
Parameters
- path: string
- Optionalconfig: T
Returns Promise<FetchResponse<V> | FetchError<W>>
Inherited from RestAPI.delete
- Defined in src/classes/rest-api.ts:89

get

get<V, W = U>(
path: string,
config?: T,
): Promise<FetchResponse<V> | FetchError<W>>
Sends a GET request to the REST API.
Type Parameters
- V
- W = U
Parameters
- path: string
- Optionalconfig: T
Returns Promise<FetchResponse<V> | FetchError<W>>
Inherited from RestAPI.get
- Defined in src/classes/rest-api.ts:96

getBaseURL

getBaseURL(): string
Returns string
Inherited from RestAPI.getBaseURL
- Defined in src/classes/rest-api.ts:202

getConfig

getConfig(): T
Returns T
Inherited from RestAPI.getConfig
- Defined in src/classes/rest-api.ts:206

handleError

handleError<V, W = U>(
    method: RequestMethod,
    path: string,
    body: V | undefined,
    config: T,
    error: FetchError<W>,
): Promise<boolean>
Handles the error of the request.
Type Parameters
- V
- W = U
Parameters
- method: RequestMethod
- path: string
- body: V | undefined
- config: T
- error: FetchError<W>
Returns Promise<boolean>
Inherited from RestAPI.handleError
- Defined in src/classes/rest-api.ts:175

handlePending

handlePending<V>(
    method: RequestMethod,
    path: string,
    body: V | undefined,
    config: T,
): Promise<boolean>
Handles the pending state of the request.
Type Parameters
- V
Parameters
- method: RequestMethod
- path: string
- body: V | undefined
- config: T
Returns Promise<boolean>
Inherited from RestAPI.handlePending
- Defined in src/classes/rest-api.ts:182

handleSuccess

handleSuccess<V, W>(
    method: RequestMethod,
    path: string,
    body: W | undefined,
    config: T,
    response: FetchResponse<V>,
): Promise<boolean>
Handles the success of the request.
Type Parameters
- V
- W
Parameters
- method: RequestMethod
- path: string
- body: W | undefined
- config: T
- response: FetchResponse<V>
Returns Promise<boolean>
Inherited from RestAPI.handleSuccess
- Defined in src/classes/rest-api.ts:189

head

head(
path: string,
config?: T,
): Promise<FetchResponse<unknown> | FetchError<unknown>>
Sends a HEAD request to the REST API.
Parameters
- path: string
- Optionalconfig: T
Returns Promise<FetchResponse<unknown> | FetchError<unknown>>
Inherited from RestAPI.head
- Defined in src/classes/rest-api.ts:103

`Protected`isConfigStatusSettable

isConfigStatusSettable(config: RestApiConfig, status: string): boolean
Checks if the config status is settable.
Parameters
- config: RestApiConfig
- status: string
Returns boolean
Inherited from RestAPI.isConfigStatusSettable
- Defined in src/classes/rest-api.ts:227

mutation

mutation<V, W extends object, X = U>(
    mutation: string,
    variables?: W,
    config?: T,
): Promise<GraphQlApiResponse<V> | FetchError<X>>
Sends a mutation to the GraphQL API.
Type Parameters
- V
- W extends object
- X = U
Parameters
- mutation: string
- Optionalvariables: W
- Optionalconfig: T
Returns Promise<GraphQlApiResponse<V> | FetchError<X>>
- Defined in src/classes/graphql-api.ts:34

options

options<V, W = U>(
path: string,
config?: T,
): Promise<FetchResponse<V> | FetchError<W>>
Sends an OPTIONS request to the REST API.
Type Parameters
- V
- W = U
Parameters
- path: string
- Optionalconfig: T
Returns Promise<FetchResponse<V> | FetchError<W>>
Inherited from RestAPI.options
- Defined in src/classes/rest-api.ts:110

patch

patch<V, W, X = U>(
    path: string,
    body?: W,
    config?: T,
): Promise<FetchResponse<V> | FetchError<X>>
Sends a PATCH request to the REST API.
Type Parameters
- V
- W
- X = U
Parameters
- path: string
- Optionalbody: W
- Optionalconfig: T
Returns Promise<FetchResponse<V> | FetchError<X>>
Inherited from RestAPI.patch
- Defined in src/classes/rest-api.ts:117

post

post<V, W, X = U>(
    query: string,
    variables?: W,
    config?: T,
): Promise<FetchResponse<V> | FetchError<X>>
Sends a POST request to the GraphQL API.
Type Parameters
- V
- W
- X = U
Parameters
- query: string
- Optionalvariables: W
- Optionalconfig: T
Returns Promise<FetchResponse<V> | FetchError<X>>
Overrides RestAPI.post
- Defined in src/classes/graphql-api.ts:20

put

put<V, W, X = U>(
    path: string,
    body?: W,
    config?: T,
): Promise<FetchResponse<V> | FetchError<X>>
Sends a PUT request to the REST API.
Type Parameters
- V
- W
- X = U
Parameters
- path: string
- Optionalbody: W
- Optionalconfig: T
Returns Promise<FetchResponse<V> | FetchError<X>>
Inherited from RestAPI.put
- Defined in src/classes/rest-api.ts:131

query

query<V, W extends object, X = U>(
    query: string,
    variables?: W,
    config?: T,
): Promise<GraphQlApiResponse<V> | FetchError<X>>
Sends a query to the GraphQL API.
Type Parameters
- V
- W extends object
- X = U
Parameters
- query: string
- Optionalvariables: W
- Optionalconfig: T
Returns Promise<GraphQlApiResponse<V> | FetchError<X>>
- Defined in src/classes/graphql-api.ts:41

`Protected`send

send<V, W, X = U>(
    method: RequestMethod,
    path: string,
    body?: W,
    config?: T,
): Promise<FetchResponse<V> | FetchError<X>>
Sends a request to the REST API.
Type Parameters
- V
- W
- X = U
Parameters
- method: RequestMethod
- path: string
- Optionalbody: W
- config: T = ...
Returns Promise<FetchResponse<V> | FetchError<X>>
Inherited from RestAPI.send
- Defined in src/classes/rest-api.ts:46

setBaseURL

setBaseURL(baseURL: string): this
Parameters
- baseURL: string
Returns this
Inherited from RestAPI.setBaseURL
- Defined in src/classes/rest-api.ts:210

`Protected`setCallStatus

setCallStatus(
    method: RequestMethod,
    path: string,
    config: T,
    status: string,
): void
Sets the status of the request.
Parameters
- method: RequestMethod
- path: string
- config: T
- status: string
Returns void
Inherited from RestAPI.setCallStatus
- Defined in src/classes/rest-api.ts:196

setConfig

setConfig(config: T): this
Parameters
- config: T
Returns this
Inherited from RestAPI.setConfig
- Defined in src/classes/rest-api.ts:217

trace

trace(
path: string,
config?: T,
): Promise<FetchResponse<unknown> | FetchError<unknown>>
Sends a TRACE request to the REST API.
Parameters
- path: string
- Optionalconfig: T
Returns Promise<FetchResponse<unknown> | FetchError<unknown>>
Inherited from RestAPI.trace
- Defined in src/classes/rest-api.ts:138

transformBody

transformBody<V>(
    method: RequestMethod,
    path: string,
    body: V | undefined,
    config: T,
): Promise<any>
Transforms the body of the request.
Type Parameters
- V
Parameters
- method: RequestMethod
- path: string
- body: V | undefined
- config: T
Returns Promise<any>
Inherited from RestAPI.transformBody
- Defined in src/classes/rest-api.ts:157

transformQueryParameters

transformQueryParameters<V>(
    method: RequestMethod,
    path: string,
    body: V | undefined,
    config: T,
): Promise<string>
Transforms the query parameters of the request.
Type Parameters
- V
Parameters
- method: RequestMethod
- path: string
- body: V | undefined
- config: T
Returns Promise<string>
Inherited from RestAPI.transformQueryParameters
- Defined in src/classes/rest-api.ts:164

write

write<V, W, X = U>(
    mode: WriteMode,
    path: string,
    body?: W,
    config?: T,
): Promise<FetchResponse<V> | FetchError<X>>
Sends a POST request if the mode is 'create' or a PUT request if the mode is 'update' to the REST API.
Type Parameters
- V
- W
- X = U
Parameters
- mode: WriteMode
- path: string
- Optionalbody: W
- Optionalconfig: T
Returns Promise<FetchResponse<V> | FetchError<X>>
Inherited from RestAPI.write
- Defined in src/classes/rest-api.ts:145

Class GraphQlAPI<T, U>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns GraphQlAPI<T, U>

Properties

ProtectedbaseURL

Protectedconfig

Readonlystatus

Methods

connect

Type Parameters

Parameters

Returns Promise<FetchResponse<V> | FetchError<W>>

delete

Type Parameters

Parameters

Returns Promise<FetchResponse<V> | FetchError<W>>

get

Type Parameters

Parameters

Returns Promise<FetchResponse<V> | FetchError<W>>

getBaseURL

Returns string

getConfig

Returns T

handleError

Type Parameters

Parameters

Returns Promise<boolean>

handlePending

Type Parameters

Parameters

Returns Promise<boolean>

handleSuccess

Type Parameters

Parameters

Returns Promise<boolean>

head

Parameters

Returns Promise<FetchResponse<unknown> | FetchError<unknown>>

ProtectedisConfigStatusSettable

Parameters

Returns boolean

mutation

Type Parameters

Parameters

Returns Promise<GraphQlApiResponse<V> | FetchError<X>>

options

Type Parameters

Parameters

Returns Promise<FetchResponse<V> | FetchError<W>>

patch

Type Parameters

Parameters

Returns Promise<FetchResponse<V> | FetchError<X>>

post

Type Parameters

Parameters

Returns Promise<FetchResponse<V> | FetchError<X>>

put

Type Parameters

Parameters

Returns Promise<FetchResponse<V> | FetchError<X>>

query

Type Parameters

Parameters

Returns Promise<GraphQlApiResponse<V> | FetchError<X>>

Protectedsend

Type Parameters

Parameters

Returns Promise<FetchResponse<V> | FetchError<X>>

setBaseURL

`Protected`baseURL

`Protected`config

`Readonly`status

`Protected`isConfigStatusSettable

`Protected`send

`Protected`setCallStatus