Class JsonApiResponse<T, U>

JSON API response wrapper.

Type Parameters

T
U = JsonApiDefaultMeta

Hierarchy

JsonApiResponse

Index

Constructors

Properties

#apiClient #data #isNeedRaw #links #meta #raw #rawData?

Accessors

data headers isLinksExist links meta pageLimit rawData rawResponse status

Methods

#parseResponse createLink fetchPage

Constructors

constructor

new JsonApiResponse<T, U>(opts: {
    apiClient: JsonApiClient;
    isNeedRaw: boolean;
    raw: JsonApiResponseRaw;
}): JsonApiResponse<T, U>
Type Parameters
- T
- U = JsonApiDefaultMeta
Parameters
- opts: {
      apiClient: JsonApiClient;
      isNeedRaw: boolean;
      raw: JsonApiResponseRaw;
  }
  - apiClient: JsonApiClient
  - isNeedRaw: boolean
  - raw: JsonApiResponseRaw
Returns JsonApiResponse<T, U>
- Defined in packages/jac/src/response.ts:31

Properties

`Private` #apiClient

#apiClient: JsonApiClient

`Private` #data

#data: T

`Private` `Readonly` #isNeedRaw

#isNeedRaw: boolean

`Private` `Readonly` #links

#links: JsonApiResponseLinks

`Private` `Readonly` #meta

#meta: U

`Private` `Readonly` #raw

#raw: JsonApiResponseRaw

`Private` `Optional` `Readonly` #rawData

#rawData?: JsonApiResponseRawData

Accessors

data

get data(): T
Get response data.

Returns T
- Defined in packages/jac/src/response.ts:80

headers

get headers(): HeadersInit
Get response headers.

Returns HeadersInit
- Defined in packages/jac/src/response.ts:94

isLinksExist

get isLinksExist(): boolean
Is response links exist.

Returns boolean
- Defined in packages/jac/src/response.ts:108

links

get links(): JsonApiResponseLinks
Get response links.

Returns JsonApiResponseLinks
- Defined in packages/jac/src/response.ts:101

meta

get meta(): U
Returns U
- Defined in packages/jac/src/response.ts:49

pageLimit

get pageLimit(): undefined | number
Get request page limit.

Returns undefined | number
- Defined in packages/jac/src/response.ts:63

rawData

get rawData(): JsonApiResponseRawData
Get raw response data.

Returns JsonApiResponseRawData
- Defined in packages/jac/src/response.ts:73

rawResponse

get rawResponse(): JsonApiResponseRaw
Get raw response.

Returns JsonApiResponseRaw
- Defined in packages/jac/src/response.ts:56

status

get status(): HTTP_STATUS_CODES
Get response HTTP status.

Returns HTTP_STATUS_CODES
- Defined in packages/jac/src/response.ts:87

Methods

`Private` #parseResponse

#parseResponse(raw: JsonApiResponseRaw, isNeedRaw: boolean): void
Parses and unwraps response data.
Parameters
- raw: JsonApiResponseRaw
- isNeedRaw: boolean
Returns void
- Defined in packages/jac/src/response.ts:115

createLink

createLink(link: string): string
Parameters
- link: string
Returns string
- Defined in packages/jac/src/response.ts:121

fetchPage

fetchPage(page: JsonApiLinkFields): Promise<JsonApiResponse<T, U>>
Parameters
- page: JsonApiLinkFields
Returns Promise<JsonApiResponse<T, U>>
- Defined in packages/jac/src/response.ts:132

Generated using TypeDoc