ApiClient | elide-jsonapi-client

Hierarchy

ApiClient

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ApiClient(__namedParameters?: { adapter: AxiosAdapter; baseURL: string; dateAttrs: string[]; headers: {}; protectedAttrs: string[]; throttleThreshold: number; timeout: number; useCache: boolean; useThrottle: boolean; pagination: object }): ApiClient

- Defined in src/index.ts:32
Parameters
- Default value __namedParameters: { adapter: AxiosAdapter; baseURL: string; dateAttrs: string[]; headers: {}; protectedAttrs: string[]; throttleThreshold: number; timeout: number; useCache: boolean; useThrottle: boolean; pagination: object } = {}
  - adapter: AxiosAdapter
  - baseURL: string
  - dateAttrs: string[]
  - headers: {}
  - protectedAttrs: string[]
  - throttleThreshold: number
  - timeout: number
  - useCache: boolean
  - useThrottle: boolean
  - pagination: object
    - size: number
    - totals: true
    - type: string
Returns ApiClient

Properties

axios

axios: AxiosInstance

dateAttrs

dateAttrs: string[]

fetch

fetch: get = this.get

headers

headers: Object

jsonPatchHeaders

jsonPatchHeaders: Object

protectedAttrs

protectedAttrs: string[]

Methods

create

create(url: string, data: NormalizedResource, options?: SerializeOptions, headers?: undefined | object): Promise<Response<{ attributes?: Attributes; id: string; links?: Links; relationships?: Relationships; type: string } | { attributes?: Attributes; id: string; links?: Links; relationships?: Relationships; type: string }[]> | NormalizedResponse>

- Defined in src/index.ts:196
Create a new resource

Serializes the request data and deserializes the response

Parameters
- url: string
  
  Resource endpoint URL
- data: NormalizedResource
  
  Normalized resource data object
- Optional options: SerializeOptions
- Optional headers: undefined | object
Returns Promise<Response<{ attributes?: Attributes; id: string; links?: Links; relationships?: Relationships; type: string } | { attributes?: Attributes; id: string; links?: Links; relationships?: Relationships; type: string }[]> | NormalizedResponse>

createRelationship

createRelationship(type: string, id: string, relationshipType: string, data: NormalizedResourceOrResources, headers?: undefined | object): Promise<AxiosResponse<any>>

- Defined in src/index.ts:343
Creates a relationship between a parent resource and the provided resource(s)

Parameters
- type: string
  
  Parent resource Type
- id: string
  
  Parent resource ID
- relationshipType: string
  
  Relationship resource Type
- data: NormalizedResourceOrResources
  
  Related resource or collection of related resources
- Optional headers: undefined | object
Returns Promise<AxiosResponse<any>>

delete

delete(url: string, data?: undefined | object, headers?: undefined | object): Promise<any>

- Defined in src/index.ts:304
Delete a resource

Can accept a resource object or collection of resources to delete

Parameters
- url: string
  
  Resource endpoint URL
- Optional data: undefined | object
- Optional headers: undefined | object
Returns Promise<any>

get

get(url: string, params?: Params, headers?: undefined | object): Promise<Response<{ attributes?: Attributes; id: string; links?: Links; relationships?: Relationships; type: string } | { attributes?: Attributes; id: string; links?: Links; relationships?: Relationships; type: string }[]> | NormalizedResponse>

- Defined in src/index.ts:144
Fetch an API resource

Parameters
- url: string
  
  Resource endpoint URL
- Default value params: Params = {}
- Optional headers: undefined | object
Returns Promise<Response<{ attributes?: Attributes; id: string; links?: Links; relationships?: Relationships; type: string } | { attributes?: Attributes; id: string; links?: Links; relationships?: Relationships; type: string }[]> | NormalizedResponse>

getHeaders

getHeaders(headers?: undefined | object, jsonPatch?: undefined | false | true): Object & object

- Defined in src/index.ts:90
Merges provided header properties with the class instance properties

Parameters
- Optional headers: undefined | object
- Optional jsonPatch: undefined | false | true
Returns Object & object

getOptions

getOptions(__namedParameters?: { dateAttrs: string[]; idRequired: boolean; protectedAttrs: string[] }): { dateAttrs: never[]; idRequired: boolean; protectedAttrs: never[] }

- Defined in src/index.ts:106
Merges provided options with the class instance options

property

{string[]} [dateAttrs] Date attributes to be serialized

property

{bool} [idRequired] Is the resource ID required?

property

{string[]} [protectedAttrs] Attributes to be stripped from payload

Parameters
- Default value __namedParameters: { dateAttrs: string[]; idRequired: boolean; protectedAttrs: string[] } = {} as SerializeOptions
  - dateAttrs: string[]
  - idRequired: boolean
  - protectedAttrs: string[]
Returns { dateAttrs: never[]; idRequired: boolean; protectedAttrs: never[] }
- dateAttrs: never[]
- idRequired: boolean
- protectedAttrs: never[]

mutate

mutate(url: string, op: OperationType, path: string, data: NormalizedResource[], headers?: undefined | object): Promise<(null | { id: string; type: string } | { errors: Error[] })[]>

- Defined in src/index.ts:274
JSON Patch Extension mutation

Parameters
- url: string
  
  Resource endpoint URL
- op: OperationType
  
  Mutation operation type
- path: string
  
  Resource path
- data: NormalizedResource[]
  
  Normalized resource data objects
- Optional headers: undefined | object
Returns Promise<(null | { id: string; type: string } | { errors: Error[] })[]>

patch

patch(url: string, data: object, headers?: undefined | object, jsonPatch?: undefined | false | true): Promise<AxiosResponse<any>>

- Defined in src/index.ts:225
Update a resource

Does not serialize the request data or deserialize the response

Parameters
- url: string
  
  Resource endpoint URL
- data: object
  
  Resource data object
- Optional headers: undefined | object
- Optional jsonPatch: undefined | false | true
Returns Promise<AxiosResponse<any>>

post

post(url: string, data: object, headers?: undefined | object): Promise<AxiosResponse<any>>

- Defined in src/index.ts:173
Create a new resource

Does not serialize the request data or deserialize the response

Parameters
- url: string
  
  Resource endpoint URL
- data: object
  
  Resource data object
- Optional headers: undefined | object
Returns Promise<AxiosResponse<any>>

remove

remove(type: string, id: string | number, headers?: undefined | object): Promise<any>

- Defined in src/index.ts:324
Delete a resource by ID

Parameters
- type: string
  
  Resource type
- id: string | number
  
  Resource ID
- Optional headers: undefined | object
Returns Promise<any>

removeRelationship

removeRelationship(type: string, id: string, relationshipType: string, data: NormalizedResourceOrResources, headers?: undefined | object): Promise<any>

- Defined in src/index.ts:372
Removes a relationship between a parent resource and the provided resource(s)

Parameters
- type: string
  
  Parent resource Type
- id: string
  
  Parent resource ID
- relationshipType: string
  
  Relationship resource Type
- data: NormalizedResourceOrResources
  
  Related resource or collection of related resources
- Optional headers: undefined | object
Returns Promise<any>

serialize

serialize(data: NormalizedResource, options?: SerializeOptions): Request

- Defined in src/index.ts:129
Serializes a normalized resource object into a JSON API structure

Parameters
- data: NormalizedResource
  
  Resource object
- Optional options: SerializeOptions
Returns Request

update

update(url: string, data: NormalizedResource, options?: SerializeOptions, headers?: undefined | object): Promise<Response<{ attributes?: Attributes; id: string; links?: Links; relationships?: Relationships; type: string } | { attributes?: Attributes; id: string; links?: Links; relationships?: Relationships; type: string }[]> | NormalizedResponse>

- Defined in src/index.ts:253
Update a resource

Serializes the request data and deserializes the response

Parameters
- url: string
  
  Resource endpoint URL
- data: NormalizedResource
  
  Normalized resource data object
- Optional options: SerializeOptions
- Optional headers: undefined | object
Returns Promise<Response<{ attributes?: Attributes; id: string; links?: Links; relationships?: Relationships; type: string } | { attributes?: Attributes; id: string; links?: Links; relationships?: Relationships; type: string }[]> | NormalizedResponse>

Generated using TypeDoc

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Default value __namedParameters: { adapter: AxiosAdapter; baseURL: string; dateAttrs: string[]; headers: {}; protectedAttrs: string[]; throttleThreshold: number; timeout: number; useCache: boolean; useThrottle: boolean; pagination: object } = {}

adapter: AxiosAdapter

baseURL: string

dateAttrs: string[]

headers: {}

protectedAttrs: string[]

throttleThreshold: number

timeout: number

useCache: boolean

useThrottle: boolean

pagination: object

size: number

totals: true

type: string

Returns ApiClient

Properties

axios

dateAttrs

fetch

headers

jsonPatchHeaders

protectedAttrs

Methods

create

Parameters

url: string

data: NormalizedResource

Optional options: SerializeOptions

Optional headers: undefined | object

Returns Promise<Response<{ attributes?: Attributes; id: string; links?: Links; relationships?: Relationships; type: string } | { attributes?: Attributes; id: string; links?: Links; relationships?: Relationships; type: string }[]> | NormalizedResponse>

createRelationship

Parameters

type: string

id: string

relationshipType: string

data: NormalizedResourceOrResources

Optional headers: undefined | object

Returns Promise<AxiosResponse<any>>

delete

Parameters

url: string

Optional data: undefined | object

Optional headers: undefined | object

Returns Promise<any>

get

Parameters

url: string

Default value params: Params = {}

Optional headers: undefined | object

Returns Promise<Response<{ attributes?: Attributes; id: string; links?: Links; relationships?: Relationships; type: string } | { attributes?: Attributes; id: string; links?: Links; relationships?: Relationships; type: string }[]> | NormalizedResponse>

getHeaders

Parameters

Optional headers: undefined | object

Optional jsonPatch: undefined | false | true

Returns Object & object

getOptions

Parameters

Default value __namedParameters: { dateAttrs: string[]; idRequired: boolean; protectedAttrs: string[] } = {} as SerializeOptions

dateAttrs: string[]

idRequired: boolean

protectedAttrs: string[]

Returns { dateAttrs: never[]; idRequired: boolean; protectedAttrs: never[] }

dateAttrs: never[]

idRequired: boolean

protectedAttrs: never[]

mutate

Parameters

url: string

op: OperationType

path: string

data: NormalizedResource[]

Optional headers: undefined | object