CollectionCache.getItem()method
Get (or create) the ItemStore for the given id.
getItem(id: I): ItemStore<I, T>
new CollectionCache<I, T>(collection: Collection<string, I, T>, provider: DBProvider<I>, memory?: MemoryDBProvider<I>)
| Param | Type | |
|---|---|---|
collection | Collection<string, I, T> | The collection to cache stores for. required |
provider | DBProvider<I> | The database provider the stores fetch from. required |
memory | MemoryDBProvider<I> | Optional memory provider used to seed stores and drive realtime updates. |
| Return | |
|---|---|
CollectionCache<I, T> | Cache of ItemStore and QueryStore objects for a single collection. |
| Property | Type | |
|---|---|---|
.collection | Collection<string, I, T> | The collection these cached stores belong to. required readonly |
.provider | DBProvider<I> | The database provider the cached stores fetch from. required readonly |
.memory | MemoryDBProvider<I> | Optional memory provider used to seed stores and drive realtime updates. readonly |
Cache of ItemStore and QueryStore objects for a single collection.
getItem(id) to retrieve or create the ItemStore for a given id.getQuery(query) to retrieve or create the QueryStore for a given query.const cache = new CollectionCache(collection, provider);
const store = cache.getItem("abc");Get (or create) the ItemStore for the given id.
getItem(id: I): ItemStore<I, T>
Get (or create) the QueryStore for the given query.
getQuery(query: Query<Item<I, T>>): QueryStore<I, T>
Refresh a specific item store.
refreshItem(id: I, maxAge?: number): Promise<void>
Refresh every cached item store.
refreshItems(maxAge?: number): Promise<void>
Refresh a specific query store.
refreshQuery(query: Query<Item<I, T>>, maxAge?: number): Promise<void>
Refresh every cached query store.
refreshQueries(maxAge?: number): Promise<void>
Refresh every cached store (items and queries).
refreshAll(maxAge?: number): Promise<void>