--- url: https://canary.warp-drive.io/api/@warp-drive/json-api/classes/JSONAPICache.md description: >- The JSON:API cache implementation: stores documents and normalized resources, tracks local, in-flight, and remote state, and manages relationships through the graph. --- # JSONAPICache Defined in: [-private/cache.ts:321](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L321) ```ts import { JSONAPICache } from '@warp-drive/json-api'; ``` A Cache implementation tuned for [{json:api}](https://jsonapi.org/) See [How The Cache Works](/guides/the-manual/caching/#how-the-cache-works) for the caching strategy it uses. ## Implements * `Cache` ## Constructors ### Constructor ```ts new JSONAPICache(capabilities: CacheCapabilitiesManager$1): JSONAPICache; ``` Defined in: [-private/cache.ts:340](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L340) #### Parameters ##### capabilities `CacheCapabilitiesManager$1` #### Returns `JSONAPICache` ## Cache Management APIs for primary cache management functionality ### mutate() ```ts mutate(mutation: LocalRelationshipOperation): void; ``` Defined in: [-private/cache.ts:635](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L635) Update the "local" or "current" (unpersisted) state of the Cache #### Parameters ##### mutation [`LocalRelationshipOperation`](../../core/types/graph/types/LocalRelationshipOperation.md) #### Returns `void` #### Example ```ts cache.mutate({ op: 'replaceRelatedRecord', record: identifier, field: 'author', value: authorIdentifier, }); ``` #### Implementation of ```ts Cache.mutate ``` *** ### patch() ```ts patch(op: | Operation | Operation[]): void; ``` Defined in: [-private/cache.ts:597](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L597) Update the "remote" or "canonical" (persisted) state of the Cache by merging new information into the existing state. #### Parameters ##### op | [`Operation`](../../core/types/cache/operations/types/Operation.md) | [`Operation`](../../core/types/cache/operations/types/Operation.md)\[] the operation or list of operations to perform #### Returns `void` #### Example ```ts cache.patch({ op: 'update', record: identifier, field: 'name', value: 'Chris', }); ``` #### Implementation of ```ts Cache.patch ``` *** ### peek() ```ts peek(identifier: ResourceKey): | ResourceObject | null; peek(identifier: RequestKey): | ResourceDocument | null; ``` #### Call Signature ```ts peek(identifier: ResourceKey): | ResourceObject | null; ``` Defined in: [-private/cache.ts:700](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L700) Peek resource data from the Cache. In development, if the return value is JSON the return value will be deep-cloned and deep-frozen to prevent mutation thereby enforcing cache Immutability. This form of peek is useful for implementations that want to feed raw-data from cache to the UI or which want to interact with a blob of data directly from the presentation cache. An implementation might want to do this because de-referencing records which read from their own blob is generally safer because the record does not require retainining connections to the Store and Cache to present data on a per-field basis. This generally takes the place of [getAttr](#getattr) as an API and may even take the place of [getRelationship](#getrelationship) depending on implementation specifics, though this latter usage is less recommended due to the advantages of the Graph handling necessary entanglements and notifications for relational data. :::warning It is not recommended to use the return value as a serialized representation of the resource both due to it containing local mutations and because it may contain additional fields not recognized by the {json:api} API implementation such as `lid` and the various internal WarpDrive bookkeeping fields. ::: ##### Parameters ###### identifier [`ResourceKey`](../../core/types/identifier/types/ResourceKey.md) ##### Returns | [`ResourceObject`](../../core/types/spec/json-api-raw/types/ResourceObject.md) | `null` ##### Example ```ts const resource = cache.peek(identifier); const document = cache.peek(requestKey); ``` ##### Implementation of ```ts Cache.peek ``` #### Call Signature ```ts peek(identifier: RequestKey): | ResourceDocument | null; ``` Defined in: [-private/cache.ts:701](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L701) Peek the Cache for the [document](../../core/types/spec/document/types/ResourceDocument.md) associated with a request. ##### Parameters ###### identifier [`RequestKey`](../../core/types/identifier/types/RequestKey.md) ##### Returns | [`ResourceDocument`](../../core/types/spec/document/types/ResourceDocument.md) | `null` the known document data, if any ##### Implementation of ```ts Cache.peek ``` *** ### peekRemoteState() ```ts peekRemoteState(identifier: ResourceKey): | ResourceObject | null; peekRemoteState(identifier: RequestKey): | ResourceDocument | null; ``` #### Call Signature ```ts peekRemoteState(identifier: ResourceKey): | ResourceObject | null; ``` Defined in: [-private/cache.ts:771](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L771) Peek the remote resource data from the Cache. ##### Parameters ###### identifier [`ResourceKey`](../../core/types/identifier/types/ResourceKey.md) ##### Returns | [`ResourceObject`](../../core/types/spec/json-api-raw/types/ResourceObject.md) | `null` ##### Example ```ts const resource = cache.peekRemoteState(identifier); const document = cache.peekRemoteState(requestKey); ``` ##### Implementation of ```ts Cache.peekRemoteState ``` #### Call Signature ```ts peekRemoteState(identifier: RequestKey): | ResourceDocument | null; ``` Defined in: [-private/cache.ts:772](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L772) Peek remote [document](../../core/types/spec/document/types/ResourceDocument.md) data for a request from the Cache. This will give the data provided from the server without any local changes. ##### Parameters ###### identifier [`RequestKey`](../../core/types/identifier/types/RequestKey.md) ##### Returns | [`ResourceDocument`](../../core/types/spec/document/types/ResourceDocument.md) | `null` the known document data, if any ##### Implementation of ```ts Cache.peekRemoteState ``` *** ### peekRequest() ```ts peekRequest(identifier: RequestKey): | StructuredDocument | null; ``` Defined in: [-private/cache.ts:844](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L844) Peek the Cache for the existing request data associated with a cacheable request. This is effectively the reverse of [put](#put) for a request in that it will return the the request, response, and content whereas [peek](#peek) will return just the `content`. #### Parameters ##### identifier [`RequestKey`](../../core/types/identifier/types/RequestKey.md) #### Returns | `StructuredDocument`<[`ResourceDocument`](../../core/types/spec/document/types/ResourceDocument.md)> | `null` #### Example ```ts const doc = cache.peekRequest(requestKey); ``` #### Implementation of ```ts Cache.peekRequest ``` *** ### put() ```ts put(doc: StructuredDataDocument): SingleResourceDataDocument; put(doc: StructuredDataDocument): CollectionResourceDataDocument; put(doc: StructuredErrorDocument): ResourceErrorDocument; put(doc: StructuredDataDocument): ResourceMetaDocument; ``` #### Call Signature ```ts put(doc: StructuredDataDocument): SingleResourceDataDocument; ``` Defined in: [-private/cache.ts:390](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L390) Cache the response to a request Implements Cache.put | Cache.put. Expects a StructuredDocument whose `content` member is a JsonApiDocument. ```js cache.put({ request: { url: 'https://api.example.com/v1/user/1' }, content: { data: { type: 'user', id: '1', attributes: { name: 'Chris' } } } }) ``` > **Note** > The nested `content` and `data` members are not a mistake. This is because > there are two separate concepts involved here, the `StructuredDocument` which contains > the context of a given Request that has been issued with the returned contents as its > `content` property, and a `JSON:API Document` which is the json contents returned by > this endpoint and which uses its `data` property to signify which resources are the > primary resources associated with the request. StructuredDocument's with urls will be cached as full documents with associated resource membership order and contents preserved but linked into the cache. ##### Type Parameters ###### T `T` *extends* [`SingleResourceDocument`](../../core/types/spec/json-api-raw/types/SingleResourceDocument.md) ##### Parameters ###### doc `StructuredDataDocument`<`T`> ##### Returns [`SingleResourceDataDocument`](../../core/types/spec/document/types/SingleResourceDataDocument.md) ##### Implementation of ```ts Cache.put ``` #### Call Signature ```ts put(doc: StructuredDataDocument): CollectionResourceDataDocument; ``` Defined in: [-private/cache.ts:391](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L391) Cache the response to a request Implements Cache.put | Cache.put. Expects a StructuredDocument whose `content` member is a JsonApiDocument. ```js cache.put({ request: { url: 'https://api.example.com/v1/user/1' }, content: { data: { type: 'user', id: '1', attributes: { name: 'Chris' } } } }) ``` > **Note** > The nested `content` and `data` members are not a mistake. This is because > there are two separate concepts involved here, the `StructuredDocument` which contains > the context of a given Request that has been issued with the returned contents as its > `content` property, and a `JSON:API Document` which is the json contents returned by > this endpoint and which uses its `data` property to signify which resources are the > primary resources associated with the request. StructuredDocument's with urls will be cached as full documents with associated resource membership order and contents preserved but linked into the cache. ##### Type Parameters ###### T `T` *extends* [`CollectionResourceDocument`](../../core/types/spec/json-api-raw/types/CollectionResourceDocument.md) ##### Parameters ###### doc `StructuredDataDocument`<`T`> ##### Returns [`CollectionResourceDataDocument`](../../core/types/spec/document/types/CollectionResourceDataDocument.md) ##### Implementation of ```ts Cache.put ``` #### Call Signature ```ts put(doc: StructuredErrorDocument): ResourceErrorDocument; ``` Defined in: [-private/cache.ts:392](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L392) Cache the response to a request Implements Cache.put | Cache.put. Expects a StructuredDocument whose `content` member is a JsonApiDocument. ```js cache.put({ request: { url: 'https://api.example.com/v1/user/1' }, content: { data: { type: 'user', id: '1', attributes: { name: 'Chris' } } } }) ``` > **Note** > The nested `content` and `data` members are not a mistake. This is because > there are two separate concepts involved here, the `StructuredDocument` which contains > the context of a given Request that has been issued with the returned contents as its > `content` property, and a `JSON:API Document` which is the json contents returned by > this endpoint and which uses its `data` property to signify which resources are the > primary resources associated with the request. StructuredDocument's with urls will be cached as full documents with associated resource membership order and contents preserved but linked into the cache. ##### Type Parameters ###### T `T` *extends* [`ResourceErrorDocument`](../../core/types/spec/document/types/ResourceErrorDocument.md) ##### Parameters ###### doc `StructuredErrorDocument`<`T`> ##### Returns [`ResourceErrorDocument`](../../core/types/spec/document/types/ResourceErrorDocument.md) ##### Implementation of ```ts Cache.put ``` #### Call Signature ```ts put(doc: StructuredDataDocument): ResourceMetaDocument; ``` Defined in: [-private/cache.ts:393](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L393) Cache the response to a request Implements Cache.put | Cache.put. Expects a StructuredDocument whose `content` member is a JsonApiDocument. ```js cache.put({ request: { url: 'https://api.example.com/v1/user/1' }, content: { data: { type: 'user', id: '1', attributes: { name: 'Chris' } } } }) ``` > **Note** > The nested `content` and `data` members are not a mistake. This is because > there are two separate concepts involved here, the `StructuredDocument` which contains > the context of a given Request that has been issued with the returned contents as its > `content` property, and a `JSON:API Document` which is the json contents returned by > this endpoint and which uses its `data` property to signify which resources are the > primary resources associated with the request. StructuredDocument's with urls will be cached as full documents with associated resource membership order and contents preserved but linked into the cache. ##### Type Parameters ###### T `T` *extends* [`ResourceMetaDocument`](../../core/types/spec/document/types/ResourceMetaDocument.md) ##### Parameters ###### doc `StructuredDataDocument`<`T`> ##### Returns [`ResourceMetaDocument`](../../core/types/spec/document/types/ResourceMetaDocument.md) ##### Implementation of ```ts Cache.put ``` *** ### upsert() ```ts upsert( identifier: ResourceKey, data: ExistingResourceObject, calculateChanges?: boolean ): void | string[]; ``` Defined in: [-private/cache.ts:866](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L866) Push resource data from a remote source into the cache for this identifier #### Parameters ##### identifier [`ResourceKey`](../../core/types/identifier/types/ResourceKey.md) ##### data [`ExistingResourceObject`](../../core/types/spec/json-api-raw/types/ExistingResourceObject.md) ##### calculateChanges? `boolean` #### Returns `void` | `string`\[] when `calculateChanges` is true, the names of the attributes whose persisted value this push changed (the same keys the `'remote'` channel is notified with), or `undefined` when none did. Otherwise `void`. #### Example ```ts cache.upsert(identifier, { type: 'user', id: '1', attributes: { name: 'Chris' }, }); ``` #### Implementation of ```ts Cache.upsert ``` ## Resource Lifecycle APIs that support management of resource data ### clientDidCreate() ```ts clientDidCreate(identifier: ResourceKey, options?: Record): Record; ``` Defined in: [-private/cache.ts:1003](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L1003) \[LIFECYCLE] Signal to the cache that a new record has been instantiated on the client It returns properties from options that should be set on the record during the create process. This return value behavior is deprecated. #### Parameters ##### identifier [`ResourceKey`](../../core/types/identifier/types/ResourceKey.md) ##### options? [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, [`Value`](../../core/types/json/raw/types/Value.md)> #### Returns [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `unknown`> #### Example ```ts cache.clientDidCreate(identifier, { name: 'Chris' }); ``` #### Implementation of ```ts Cache.clientDidCreate ``` *** ### commitWasRejected() ```ts commitWasRejected(identifier: | ResourceKey | ResourceKey[], errors?: ApiError[]): void; ``` Defined in: [-private/cache.ts:1200](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L1200) \[LIFECYCLE] Signals to the cache that a resource was update via a save transaction failed. #### Parameters ##### identifier | [`ResourceKey`](../../core/types/identifier/types/ResourceKey.md) | [`ResourceKey`](../../core/types/identifier/types/ResourceKey.md)\[] ##### errors? [`ApiError`](../../core/types/spec/error/types/ApiError.md)\[] #### Returns `void` #### Example ```ts cache.commitWasRejected(identifier, errors); ``` #### Implementation of ```ts Cache.commitWasRejected ``` *** ### didCommit() ```ts didCommit(committedIdentifier: ResourceKey, result: | StructuredDataDocument, ExistingResourceObject>> | null): SingleResourceDataDocument; didCommit(committedIdentifier: ResourceKey[], result: | StructuredDataDocument, ExistingResourceObject>> | null): SingleResourceDataDocument; didCommit(committedIdentifier: ResourceKey[], result: | StructuredDataDocument>> | null): CollectionResourceDataDocument; ``` #### Call Signature ```ts didCommit(committedIdentifier: ResourceKey, result: | StructuredDataDocument, ExistingResourceObject>> | null): SingleResourceDataDocument; ``` Defined in: [-private/cache.ts:1108](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L1108) \[LIFECYCLE] Signals to the cache that a resource was successfully updated as part of a save transaction. ##### Parameters ###### committedIdentifier [`ResourceKey`](../../core/types/identifier/types/ResourceKey.md) ###### result | `StructuredDataDocument`<[`SingleResourceDataDocument`](../../core/types/spec/document/types/SingleResourceDataDocument.md)<[`ExistingResourceObject`](../../core/types/spec/json-api-raw/types/ExistingResourceObject.md)<`string`>, [`ExistingResourceObject`](../../core/types/spec/json-api-raw/types/ExistingResourceObject.md)<`string`>>> | `null` ##### Returns [`SingleResourceDataDocument`](../../core/types/spec/document/types/SingleResourceDataDocument.md) ##### Example ```ts cache.didCommit(identifier, result); ``` ##### Implementation of ```ts Cache.didCommit ``` #### Call Signature ```ts didCommit(committedIdentifier: ResourceKey[], result: | StructuredDataDocument, ExistingResourceObject>> | null): SingleResourceDataDocument; ``` Defined in: [-private/cache.ts:1112](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L1112) \[LIFECYCLE] Signals to the cache that a set of resources was successfully updated as part of a save transaction that resulted in a single resource being returned. ##### Parameters ###### committedIdentifier [`ResourceKey`](../../core/types/identifier/types/ResourceKey.md)\[] ###### result | `StructuredDataDocument`<[`SingleResourceDataDocument`](../../core/types/spec/document/types/SingleResourceDataDocument.md)<[`ExistingResourceObject`](../../core/types/spec/json-api-raw/types/ExistingResourceObject.md)<`string`>, [`ExistingResourceObject`](../../core/types/spec/json-api-raw/types/ExistingResourceObject.md)<`string`>>> | `null` a document in the cache format containing any updated data ##### Returns [`SingleResourceDataDocument`](../../core/types/spec/document/types/SingleResourceDataDocument.md) ##### Implementation of ```ts Cache.didCommit ``` #### Call Signature ```ts didCommit(committedIdentifier: ResourceKey[], result: | StructuredDataDocument>> | null): CollectionResourceDataDocument; ``` Defined in: [-private/cache.ts:1116](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L1116) \[LIFECYCLE] Signals to the cache that a set of resources was successfully updated as part of a save transaction that resulted in a collection of resources being returned. ##### Parameters ###### committedIdentifier [`ResourceKey`](../../core/types/identifier/types/ResourceKey.md)\[] ###### result | `StructuredDataDocument`<[`CollectionResourceDataDocument`](../../core/types/spec/document/types/CollectionResourceDataDocument.md)<[`ExistingResourceObject`](../../core/types/spec/json-api-raw/types/ExistingResourceObject.md)<`string`>>> | `null` a document in the cache format containing any updated data ##### Returns [`CollectionResourceDataDocument`](../../core/types/spec/document/types/CollectionResourceDataDocument.md) ##### Implementation of ```ts Cache.didCommit ``` *** ### unloadRecord() ```ts unloadRecord(identifier: ResourceKey): void; ``` Defined in: [-private/cache.ts:1225](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L1225) \[LIFECYCLE] Signals to the cache that all data for a resource should be cleared. This method is a candidate to become a mutation #### Parameters ##### identifier [`ResourceKey`](../../core/types/identifier/types/ResourceKey.md) #### Returns `void` #### Example ```ts cache.unloadRecord(identifier); ``` #### Implementation of ```ts Cache.unloadRecord ``` *** ### willCommit() ```ts willCommit(identifier: | ResourceKey | ResourceKey[], _context: RequestContext | null): void; ``` Defined in: [-private/cache.ts:1086](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L1086) \[LIFECYCLE] Signals to the cache that a resource will be part of a save transaction. #### Parameters ##### identifier | [`ResourceKey`](../../core/types/identifier/types/ResourceKey.md) | [`ResourceKey`](../../core/types/identifier/types/ResourceKey.md)\[] ##### \_context `RequestContext` | `null` #### Returns `void` #### Example ```ts cache.willCommit(identifier, context); ``` #### Implementation of ```ts Cache.willCommit ``` ## Resource Data APIs that support granular field level management of resource data ### changedAttrs() ```ts changedAttrs(identifier: ResourceKey): ChangedAttributesHash; ``` Defined in: [-private/cache.ts:1540](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L1540) Query the cache for the changed attributes of a resource: every unsaved mutation, as a `[before, after]` pair per field. `before` is the value the mutation replaces, which is not always the persisted one. A mutation a save is carrying replaces remote state; an edit made while that save is in flight replaces the in-flight value. So this is what saving from here would change, which is what `serializePatch` and the legacy `Snapshot` consume, rather than a diff against persisted state. Derived from the layers on each call, so it is always consistent with [getAttr](#getattr) and [rollbackAttrs](#rollbackattrs). Dirtiness does not go through here; see [hasChangedAttrs](#haschangedattrs). #### Parameters ##### identifier [`ResourceKey`](../../core/types/identifier/types/ResourceKey.md) #### Returns `ChangedAttributesHash` `{ '': ['', ''] }` #### Example ```ts const changes = cache.changedAttrs(identifier); // { name: ['Igor', 'Chris'] } ``` #### Implementation of ```ts Cache.changedAttrs ``` *** ### changedRelationships() ```ts changedRelationships(identifier: ResourceKey): Map; ``` Defined in: [-private/cache.ts:1685](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L1685) Query the cache for the changes to relationships of a resource. Returns a map of relationship names to RelationshipDiff objects. ```ts type RelationshipDiff = | { kind: 'collection'; remoteState: ResourceKey[]; additions: Set; removals: Set; localState: ResourceKey[]; reordered: boolean; } | { kind: 'resource'; remoteState: ResourceKey | null; localState: ResourceKey | null; }; ``` #### Parameters ##### identifier [`ResourceKey`](../../core/types/identifier/types/ResourceKey.md) #### Returns [`Map`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)<`string`, `RelationshipDiff`> #### Example ```ts const diffs = cache.changedRelationships(identifier); const comments = diffs.get('comments'); ``` #### Implementation of ```ts Cache.changedRelationships ``` *** ### getAttr() ```ts getAttr(identifier: ResourceKey, attr: string | string[]): Value | undefined; ``` Defined in: [-private/cache.ts:1313](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L1313) Retrieve the data for an attribute from the cache with local mutations applied. #### Parameters ##### identifier [`ResourceKey`](../../core/types/identifier/types/ResourceKey.md) ##### attr `string` | `string`\[] #### Returns [`Value`](../../core/types/json/raw/types/Value.md) | `undefined` #### Example ```ts const name = cache.getAttr(identifier, 'name'); const zip = cache.getAttr(identifier, ['address', 'zip']); ``` #### Implementation of ```ts Cache.getAttr ``` *** ### getRelationship() ```ts getRelationship(identifier: ResourceKey, field: string): | ResourceRelationship | CollectionRelationship; ``` Defined in: [-private/cache.ts:1744](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L1744) Query the cache for the current state of a relationship property #### Parameters ##### identifier [`ResourceKey`](../../core/types/identifier/types/ResourceKey.md) ##### field `string` #### Returns | [`ResourceRelationship`](../../core/types/cache/relationship/types/ResourceRelationship.md)<[`ResourceKey`](../../core/types/identifier/types/ResourceKey.md)> | [`CollectionRelationship`](../../core/types/cache/relationship/types/CollectionRelationship.md)<[`ResourceKey`](../../core/types/identifier/types/ResourceKey.md)> resource relationship object #### Example ```ts const relationship = cache.getRelationship(identifier, 'comments'); ``` #### Implementation of ```ts Cache.getRelationship ``` *** ### getRemoteAttr() ```ts getRemoteAttr(identifier: ResourceKey, attr: string | string[]): Value | undefined; ``` Defined in: [-private/cache.ts:1365](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L1365) Retrieve the remote data for an attribute from the cache #### Parameters ##### identifier [`ResourceKey`](../../core/types/identifier/types/ResourceKey.md) ##### attr `string` | `string`\[] #### Returns [`Value`](../../core/types/json/raw/types/Value.md) | `undefined` #### Example ```ts const name = cache.getRemoteAttr(identifier, 'name'); ``` #### Implementation of ```ts Cache.getRemoteAttr ``` *** ### getRemoteRelationship() ```ts getRemoteRelationship(identifier: ResourceKey, field: string): | ResourceRelationship | CollectionRelationship; ``` Defined in: [-private/cache.ts:1760](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L1760) Query the cache for the remote state of a relationship property #### Parameters ##### identifier [`ResourceKey`](../../core/types/identifier/types/ResourceKey.md) ##### field `string` #### Returns | [`ResourceRelationship`](../../core/types/cache/relationship/types/ResourceRelationship.md)<[`ResourceKey`](../../core/types/identifier/types/ResourceKey.md)> | [`CollectionRelationship`](../../core/types/cache/relationship/types/CollectionRelationship.md)<[`ResourceKey`](../../core/types/identifier/types/ResourceKey.md)> resource relationship object #### Example ```ts const relationship = cache.getRemoteRelationship(identifier, 'comments'); ``` #### Implementation of ```ts Cache.getRemoteRelationship ``` *** ### hasChangedAttrs() ```ts hasChangedAttrs(identifier: ResourceKey): boolean; ``` Defined in: [-private/cache.ts:1584](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L1584) Query the cache for whether any mutated attributes exist #### Parameters ##### identifier [`ResourceKey`](../../core/types/identifier/types/ResourceKey.md) #### Returns `boolean` #### Example ```ts if (cache.hasChangedAttrs(identifier)) { // ... } ``` #### Implementation of ```ts Cache.hasChangedAttrs ``` *** ### hasChangedRelationships() ```ts hasChangedRelationships(identifier: ResourceKey): boolean; ``` Defined in: [-private/cache.ts:1702](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L1702) Query the cache for whether any mutated relationships exist #### Parameters ##### identifier [`ResourceKey`](../../core/types/identifier/types/ResourceKey.md) #### Returns `boolean` #### Example ```ts if (cache.hasChangedRelationships(identifier)) { // ... } ``` #### Implementation of ```ts Cache.hasChangedRelationships ``` *** ### rollbackAttrs() ```ts rollbackAttrs(identifier: ResourceKey): string[]; ``` Defined in: [-private/cache.ts:1617](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L1617) Tell the cache to discard any uncommitted mutations to attributes This method is a candidate to become a mutation #### Parameters ##### identifier [`ResourceKey`](../../core/types/identifier/types/ResourceKey.md) #### Returns `string`\[] the names of fields that were restored #### Example ```ts const restoredKeys = cache.rollbackAttrs(identifier); ``` #### Implementation of ```ts Cache.rollbackAttrs ``` *** ### rollbackRelationships() ```ts rollbackRelationships(identifier: ResourceKey): string[]; ``` Defined in: [-private/cache.ts:1722](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L1722) Tell the cache to discard any uncommitted mutations to relationships. This will also discard the change on any appropriate inverses. This method is a candidate to become a mutation #### Parameters ##### identifier [`ResourceKey`](../../core/types/identifier/types/ResourceKey.md) #### Returns `string`\[] the names of relationships that were restored #### Example ```ts const restoredFields = cache.rollbackRelationships(identifier); ``` #### Implementation of ```ts Cache.rollbackRelationships ``` *** ### setAttr() ```ts setAttr( identifier: ResourceKey, attr: string | string[], value: Value ): void; ``` Defined in: [-private/cache.ts:1419](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L1419) Mutate the data for an attribute in the cache This method is a candidate to become a mutation #### Parameters ##### identifier [`ResourceKey`](../../core/types/identifier/types/ResourceKey.md) ##### attr `string` | `string`\[] ##### value [`Value`](../../core/types/json/raw/types/Value.md) #### Returns `void` #### Example ```ts cache.setAttr(identifier, 'name', 'Chris'); ``` #### Implementation of ```ts Cache.setAttr ``` ## Resource State APIs that support managing Resource states ### getErrors() ```ts getErrors(identifier: ResourceKey): ApiError[]; ``` Defined in: [-private/cache.ts:1800](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L1800) Query the cache for any validation errors applicable to the given resource. #### Parameters ##### identifier [`ResourceKey`](../../core/types/identifier/types/ResourceKey.md) #### Returns [`ApiError`](../../core/types/spec/error/types/ApiError.md)\[] #### Example ```ts const errors = cache.getErrors(identifier); ``` #### Implementation of ```ts Cache.getErrors ``` *** ### isDeleted() ```ts isDeleted(identifier: ResourceKey): boolean; ``` Defined in: [-private/cache.ts:1855](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L1855) Query the cache for whether a given resource is marked as deleted (but not necessarily persisted yet). #### Parameters ##### identifier [`ResourceKey`](../../core/types/identifier/types/ResourceKey.md) #### Returns `boolean` #### Example ```ts if (cache.isDeleted(identifier)) { // ... } ``` #### Implementation of ```ts Cache.isDeleted ``` *** ### isDeletionCommitted() ```ts isDeletionCommitted(identifier: ResourceKey): boolean; ``` Defined in: [-private/cache.ts:1874](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L1874) Query the cache for whether a given resource has been deleted and that deletion has also been persisted. #### Parameters ##### identifier [`ResourceKey`](../../core/types/identifier/types/ResourceKey.md) #### Returns `boolean` #### Example ```ts if (cache.isDeletionCommitted(identifier)) { // ... } ``` #### Implementation of ```ts Cache.isDeletionCommitted ``` *** ### isEmpty() ```ts isEmpty(identifier: ResourceKey): boolean; ``` Defined in: [-private/cache.ts:1817](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L1817) Query the cache for whether a given resource has any available data #### Parameters ##### identifier [`ResourceKey`](../../core/types/identifier/types/ResourceKey.md) #### Returns `boolean` #### Example ```ts if (cache.isEmpty(identifier)) { // ... } ``` #### Implementation of ```ts Cache.isEmpty ``` *** ### isNew() ```ts isNew(identifier: ResourceKey): boolean; ``` Defined in: [-private/cache.ts:1836](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L1836) Query the cache for whether a given resource was created locally and not yet persisted. #### Parameters ##### identifier [`ResourceKey`](../../core/types/identifier/types/ResourceKey.md) #### Returns `boolean` #### Example ```ts if (cache.isNew(identifier)) { // ... } ``` #### Implementation of ```ts Cache.isNew ``` *** ### setIsDeleted() ```ts setIsDeleted(identifier: ResourceKey, isDeleted: boolean): void; ``` Defined in: [-private/cache.ts:1782](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L1782) Update the cache state for the given resource to be marked as locally deleted, or remove such a mark. This method is a candidate to become a mutation #### Parameters ##### identifier [`ResourceKey`](../../core/types/identifier/types/ResourceKey.md) ##### isDeleted `boolean` #### Returns `void` #### Example ```ts cache.setIsDeleted(identifier, true); ``` #### Implementation of ```ts Cache.setIsDeleted ``` ## Other ### version ```ts version: "2"; ``` Defined in: [-private/cache.ts:327](https://github.com/warp-drive-data/warp-drive/blob/48dc0d277b98008082669dadc6a52e5c5682ef8e/warp-drive-packages/json-api/src/-private/cache.ts#L327) The Cache Version that this implementation implements. #### Implementation of ```ts Cache.version ```