@gridironsolutions/jsonapi-client v1.0.12
Table of Contents
JsonApiClient
JSON:API Client
Parameters
options
Object Configuration options
getOptions
Get client options
Returns Object
get
Fetch remote object and return it as a JsonApiDocument
Parameters
Returns Promise<JsonApiDocument>
patch
Update remote object
Parameters
patchMultiple
Update remote objects
Parameters
JsonApiDocument
Extends JsonApiModel
A JSON:API-compliant document object
Parameters
JsonApiError
Extends JsonApiModel
A JSON:API-compliant JSON:API object
Parameters
jsonApiError
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
JsonApiResource
Extends JsonApiModel
A JSON:API-compliant resource object
Parameters
resource
Object
toJsonApiDocument
Wrap this resource in a JsonApiDocument
Returns JsonApiDocument
from
Build a new JsonApiResource from id, attributes, and included
Parameters
Returns JsonApiResource
fromMultiple
Build a new JsonApiResource from an array of objects with id, attributes, and included properties
Parameters
Returns JsonApiResource
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago