Class <Interface> Cache

public

The interface for EmberData Caches.

A Cache handles in-memory storage of Document and Resource data.

Show:

identifier
createArgs

[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.

identifier
errors

[LIFECYCLE] Signals to the cache that a resource was update via a save transaction failed.

identifier
- the primary identifier that was operated on
data
- a document in the cache format containing any updated data
returns
SingleResourceDataDocument

[LIFECYCLE] Signals to the cache that a resource was successfully updated as part of a save transaction.

Generate the list of changes applied to all record in the store.

Each individual resource or document that has been mutated should be described as an individual Change entry in the returned array.

A Change is described by an object containing up to three properties: (1) the identifier of the entity that changed; (2) the op code of that change being one of upsert or remove, and if the op is upsert a patch containing the data to merge into the cache for the given entity.

This patch is opaque to the Store but should be understood by the Cache and may expect to be utilized by an Adapter when generating data during a save operation.

It is generally recommended that the patch contain only the updated state, ignoring fields that are unchanged

1
2
3
4
5
interface Change {
 identifier: StableRecordIdentifier | StableDocumentIdentifier;
 op: 'upsert' | 'remove';
 patch?: unknown;
}
returns
Promise<ReadableStream>

Serialize the entire contents of the Cache into a Stream which may be fed back into a new instance of the same Cache via cache.hydrate.

returns
Promise<Cache>

Create a fork of the cache from the current state.

Applications should typically not call this method themselves, preferring instead to fork at the Store level, which will utilize this method to fork the cache.

identifier
field
returns
Unknown

Retrieve the data for an attribute from the cache

identifier
returns
JsonApiError[]

Query the cache for any validation errors applicable to the given resource.

identifier
field
returns
resource relationship object

Query the cache for the current state of a relationship property

identifier
returns
Boolean

Query the cache for whether any mutated attributes exist

stream
ReadableStream
returns
Promise<void>

hydrate a Cache from a Stream with content previously serialized from another instance of the same Cache, resolving when hydration is complete.

This method should expect to be called both in the context of restoring the Cache during application rehydration after SSR AND at unknown times during the lifetime of an already booted application when it is desired to bulk-load additional information into the cache. This latter behavior supports optimizing pre/fetching of data for route transitions via data-only SSR modes.

identifier
returns
Boolean

Query the cache for whether a given resource is marked as deleted (but not necessarily persisted yet).

identifier
returns
Boolean

Query the cache for whether a given resource has been deleted and that deletion has also been persisted.

identifier
returns
Boolean

Query the cache for whether a given resource has any available data

identifier
returns
Boolean

Query the cache for whether a given resource was created locally and not yet persisted.

cache
Cache
returns
Promise<void>

Merge a fork back into a parent Cache.

Applications should typically not call this method themselves, preferring instead to merge at the Store level, which will utilize this method to merge the caches.

mutation
Mutation
returns
Void

Update the "local" or "current" (unpersisted) state of the Cache

op
Operation
the operation to perform
returns
Void

Update the "remote" or "canonical" (persisted) state of the Cache by merging new information into the existing state.

Note: currently the only valid resource operation is a MergeOperation which occurs when a collision of identifiers is detected.

identifier
StableRecordIdentifier | StableDocumentIdentifier
returns
ResourceDocument | ResourceBlob | null
the known resource data

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 as an API and may even take the place of 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.

UNKNOWN
StableDocumentIdentifier
returns
StableDocumentIdentifier | null

Peek the Cache for the existing request data associated with a cacheable request

doc
StructuredDocument
returns
ResourceDocument

Cache the response to a request

Unlike store.push which has UPSERT semantics, put has replace semantics similar to the http method PUT

the individually cacheable resource data it may contain should upsert, but the document data surrounding it should fully replace any existing information

Note that in order to support inserting arbitrary data to the cache that did not originate from a request put should expect to sometimes encounter a document with only a content member and therefor must not assume the existence of request and response on the document.

identifier
returns
String[]
the names of fields that were restored

Tell the cache to discard any uncommitted mutations to attributes

This method is a candidate to become a mutation

identifier
field
value

Mutate the data for an attribute in the cache

This method is a candidate to become a mutation

identifier
isDeleted
Boolean

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

identifier

[LIFECYCLE] Signals to the cache that all data for a resource should be cleared.

This method is a candidate to become a mutation

identifier
data
hasRecord
returns
Void | string[]
if `hasRecord` is true then calculated key changes should be returned

Push resource data from a remote source into the cache for this identifier

identifier

[LIFECYCLE] Signals to the cache that a resource will be part of a save transaction.