Class JsonApiClient

Represents JsonApiClient that performs requests to backend

Hierarchy

JsonApiClient

Index

Constructors

constructor

new JsonApiClient(config: FetcherConfig, interceptors?: FetcherInterceptor[]): JsonApiClient
Parameters
- config: FetcherConfig
- Optional interceptors: FetcherInterceptor[]
Returns JsonApiClient
- Defined in packages/jac/src/json-api.ts:32

Properties

`Private` #fetcher

#fetcher: Fetcher

Accessors

baseUrl

get baseUrl(): string
Base URL will be prepended to url unless url is absolute. It can be convenient to set baseUrl for an instance of fetcher to pass relative URLs to methods of that instance.

Returns string
- Defined in packages/jac/src/json-api.ts:69

fetcher

get fetcher(): Fetcher
Sets Fetcher instance to the client instance.

Returns Fetcher
- Defined in packages/jac/src/json-api.ts:52

Methods

abort

abort(requestId?: string): boolean
Interrupts the request by given requestId, if request is not found returns false.
Parameters
- Optional requestId: string
Returns boolean
- Defined in packages/jac/src/json-api.ts:119

addInterceptor

addInterceptor(interceptor: FetcherInterceptor): void
Sets new interceptor to the current Fetcher instance.
Parameters
- interceptor: FetcherInterceptor
Returns void
- Defined in packages/jac/src/json-api.ts:91

clearInterceptors

clearInterceptors(): void
Clears all existing interceptors from the Fetcher instance.

Returns void
- Defined in packages/jac/src/json-api.ts:105

clone

clone(): JsonApiClient
Clones current JsonApiClient instance

Returns JsonApiClient
- Defined in packages/jac/src/json-api.ts:42

createRequestId

createRequestId(): string
Generates new request id in the UUID format.

Returns string
- Defined in packages/jac/src/json-api.ts:112

delete

delete<T, U>(endpoint: string, opts?: Partial<JsonApiClientRequestOpts>): Promise<JsonApiResponse<T, U>>
Makes a DELETE to a target endpoint with the provided data as body. Parses the response in JsonApi format.
Type Parameters
- T
- U = JsonApiDefaultMeta
Parameters
- endpoint: string
- Optional opts: Partial<JsonApiClientRequestOpts>
Returns Promise<JsonApiResponse<T, U>>
- Defined in packages/jac/src/json-api.ts:220

get

get<T, U>(endpoint: string, opts?: Partial<JsonApiClientRequestOpts>): Promise<JsonApiResponse<T, U>>
Makes a GET to a target endpoint with the provided query params. Parses the response in JsonApi format.
Type Parameters
- T
- U = JsonApiDefaultMeta
Parameters
- endpoint: string
- Optional opts: Partial<JsonApiClientRequestOpts>
Returns Promise<JsonApiResponse<T, U>>
- Defined in packages/jac/src/json-api.ts:159

patch

patch<T, U>(endpoint: string, opts?: Partial<JsonApiClientRequestOpts>): Promise<JsonApiResponse<T, U>>
Makes a PATCH to a target endpoint with the provided data as body. Signing can be enabled with needSign argument. Parses the response in JsonApi format.
Type Parameters
- T
- U = JsonApiDefaultMeta
Parameters
- endpoint: string
- Optional opts: Partial<JsonApiClientRequestOpts>
Returns Promise<JsonApiResponse<T, U>>
- Defined in packages/jac/src/json-api.ts:190

post

post<T, U>(endpoint: string, opts?: Partial<JsonApiClientRequestOpts>): Promise<JsonApiResponse<T, U>>
Makes a POST to a target endpoint with the provided data as body. Parses the response in JsonApi format.
Type Parameters
- T
- U = JsonApiDefaultMeta
Parameters
- endpoint: string
- Optional opts: Partial<JsonApiClientRequestOpts>
Returns Promise<JsonApiResponse<T, U>>
- Defined in packages/jac/src/json-api.ts:174

put

put<T, U>(endpoint: string, opts?: Partial<JsonApiClientRequestOpts>): Promise<JsonApiResponse<T, U>>
Makes a PUT to a target endpoint with the provided data as body. Parses the response in JsonApi format.
Type Parameters
- T
- U = JsonApiDefaultMeta
Parameters
- endpoint: string
- Optional opts: Partial<JsonApiClientRequestOpts>
Returns Promise<JsonApiResponse<T, U>>
- Defined in packages/jac/src/json-api.ts:205

removeInterceptor

removeInterceptor(interceptor: FetcherInterceptor): void
Removes the existing interceptor from the Fetcher instance.
Parameters
- interceptor: FetcherInterceptor
Returns void
- Defined in packages/jac/src/json-api.ts:98

request

request<T, U>(opts: JsonApiClientRequestOpts): Promise<JsonApiResponse<T, U>>
Performs a http request
Type Parameters
- T
- U = JsonApiDefaultMeta
Parameters
- opts: JsonApiClientRequestOpts
Returns Promise<JsonApiResponse<T, U>>
- Defined in packages/jac/src/json-api.ts:126

useBaseUrl

useBaseUrl(baseUrl: string): JsonApiClient
Assigns new base URL to the current instance.
Parameters
- baseUrl: string
Returns JsonApiClient
- Defined in packages/jac/src/json-api.ts:76

useFetcher

useFetcher(fetcher: Fetcher): JsonApiClient
Sets Fetcher instance to the client instance.
Parameters
- fetcher: Fetcher
Returns JsonApiClient
- Defined in packages/jac/src/json-api.ts:59

withBaseUrl

withBaseUrl(baseUrl: string): JsonApiClient
Creates new instance JsonApiClient instance with given base URL.
Parameters
- baseUrl: string
Returns JsonApiClient
- Defined in packages/jac/src/json-api.ts:84

Class JsonApiClient

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

config: FetcherConfig

Optional interceptors: FetcherInterceptor[]

Returns JsonApiClient

Properties

Private #fetcher

Accessors

baseUrl

Returns string

fetcher

Returns Fetcher

Methods

abort

Parameters

Optional requestId: string

Returns boolean

addInterceptor

Parameters

interceptor: FetcherInterceptor

Returns void

clearInterceptors

Returns void

clone

Returns JsonApiClient

createRequestId

Returns string

delete

Type Parameters

T

U = JsonApiDefaultMeta

Parameters

endpoint: string

Optional opts: Partial<JsonApiClientRequestOpts>

Returns Promise<JsonApiResponse<T, U>>

get

Type Parameters

T

U = JsonApiDefaultMeta

Parameters

endpoint: string

Optional opts: Partial<JsonApiClientRequestOpts>

Returns Promise<JsonApiResponse<T, U>>

patch

Type Parameters

T

U = JsonApiDefaultMeta

Parameters

endpoint: string

Optional opts: Partial<JsonApiClientRequestOpts>

Returns Promise<JsonApiResponse<T, U>>

post

Type Parameters

T

U = JsonApiDefaultMeta

Parameters

endpoint: string

Optional opts: Partial<JsonApiClientRequestOpts>

Returns Promise<JsonApiResponse<T, U>>

put

Type Parameters

T

U = JsonApiDefaultMeta

Parameters

endpoint: string

Optional opts: Partial<JsonApiClientRequestOpts>

Returns Promise<JsonApiResponse<T, U>>

removeInterceptor

Parameters

interceptor: FetcherInterceptor

Returns void

request

`Optional` interceptors: FetcherInterceptor[]

`Private` #fetcher

`Optional` requestId: string

`Optional` opts: Partial<JsonApiClientRequestOpts>

`Optional` opts: Partial<JsonApiClientRequestOpts>

`Optional` opts: Partial<JsonApiClientRequestOpts>

`Optional` opts: Partial<JsonApiClientRequestOpts>

`Optional` opts: Partial<JsonApiClientRequestOpts>