README.md

Table of Contents

• JsonApiClient
  • Parameters
  • getOptions
  • get
    • Parameters
  • patch
    • Parameters
• JsonApiDocument
  • Parameters
• JsonApiError
  • Parameters
• JsonApiMeta
• JsonApiModel
• JsonApiObject
  • Parameters
• JsonApiResource
  • Parameters
  • toJsonApiDocument
  • from
    • Parameters
  • fromMultiple
    • Parameters

JsonApiClient

JSON:API Client

Parameters

• options Object Configuration options
  • options.host string Remote API host
  • options.https string Is protocol HTTPS or HTTP? (optional, default true)
  • options.port number Remote API port (optional, default 443)
  • options.basepath string? The root path of the API
  • options.debug boolean Enable debugging (optional, default false)

getOptions

Get client options

Returns Object

get

Fetch remote object and return it as a JsonApiDocument

Parameters

• path string
• model Object (optional, default UntypedResource)

Returns Promise<JsonApiDocument>

patch

Update remote object

Parameters

• path string
• resource Object

JsonApiDocument

Extends JsonApiModel

A JSON:API-compliant document object

Parameters

• document Object
  • document.jsonapi Object (optional, default JsonApiObject.#CURRENT_VERSION)
  • document.data (Object | Array<Object>)?
  • document.errors Array<Object>?
  • document.meta Object?
  • document.links Object?
  • document.included Array<Object>?
• model Object (optional, default UntypedResource)

JsonApiError

Extends JsonApiModel

A JSON:API-compliant JSON:API object

Parameters

• jsonApiError Object
  • jsonApiError.id string?
  • jsonApiError.links Object?
  • jsonApiError.status string?
  • jsonApiError.code string?
  • jsonApiError.title string?
  • jsonApiError.detail string?
  • jsonApiError.source Object?
  • jsonApiError.meta Object?

JsonApiMeta

Extends JsonApiModel

A JSON:API-compliant meta object

JsonApiModel

Base Model for JSON:API classes

JsonApiObject

Extends JsonApiModel

A JSON:API-compliant JSON:API object

Parameters

• version string (optional, default JsonApiObject.#CURRENT_VERSION)
• meta Object?

JsonApiResource

Extends JsonApiModel

A JSON:API-compliant resource object

Parameters

• resource Object
  • resource.type string?
  • resource.id string?
  • resource.attributes Object?
  • resource.included Array<Object>?

toJsonApiDocument

Wrap this resource in a JsonApiDocument

Returns JsonApiDocument

from

Build a new JsonApiResource from id, attributes, and included

Parameters

• id string
• attributes Object
• included Array<Object>

Returns JsonApiResource

fromMultiple

Build a new JsonApiResource from an array of objects with id, attributes, and included properties

Parameters

• resources Array<Object>?
  • resources[].id string
  • resources[].attributes Object
• included Array<Object>

Returns JsonApiResource