Class Store

Index

Constructors

Properties

#graph #order errors jsonapi links meta

Methods

destroy find findAll initModel reset sync syncRecord

Constructors

constructor

new Store(): Store
Returns Store

Properties

`Private` #graph

#graph: {
    [x: string]: {
        [x: string]: Model;
    };
} = {}

Type declaration

[x: string]: {
[x: string]: Model;
}
- [x: string]: Model

`Private` #order

#order: {
[x: string]: string[];
} = {}

Type declaration

[x: string]: string[]

errors

errors: undefined | ErrorObject[]

jsonapi

jsonapi: undefined | JsonApiObject

links

links: undefined | LinksObject

meta

meta: undefined | Meta

Methods

destroy

destroy(model): void
Remove a model from the store.
Parameters
- model: null | Model
  The model to destroy.
Returns void
- Defined in index.js:353

find

find(type, id): null | Model
Retrieve a model by type and id. Constant-time lookup.
Parameters
- type: string
  The type of the model.
- id: string
  The id of the model.
Returns null | Model
The corresponding model if present, and null otherwise.
- Defined in index.js:378

findAll

findAll(type): Model[]
Retrieve all models by type.
Parameters
- type: string
  The type of the model.
Returns Model[]
Array of the corresponding model if present, and empty array otherwise.
- Defined in index.js:389

initModel

initModel(type, id): Model
Initialize model.
Parameters
- type: string
  The type of the model.
- id: string
  The id of the model.
Returns Model
New model.
- Defined in index.js:427

reset

reset(): void
Empty the store.

Returns void
- Defined in index.js:409

sync

sync(payload): void
Sync a JSON API-compliant payload with the store and store any top level properties included in the payload.
Parameters
- payload: undefined | JSONAPIDocument
  The JSON API payload.
Returns void
- Defined in index.js:482

syncRecord

syncRecord(record): void
Sync record data to model.
Parameters
- record: ResourceObject
  Record data to sync.
Returns void
- Defined in index.js:460