Skip to content

Commit ceccccf

Browse files
Eliran Eretz-KedoshaCopilot
authored andcommitted
Convert remaining put() comment to JSDoc, bump version to 0.9.3
Also converts the InMemoryProvider.put() shortcut override comment (documenting indexNames scoping) to JSDoc format for consistency with InMemoryStore.put() and _getStoreTransaction(). Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 009bd0a8-f98f-4048-a261-e0a627813a00
1 parent 78dc7b1 commit ceccccf

2 files changed

Lines changed: 10 additions & 8 deletions

File tree

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@microsoft/objectstoreprovider",
3-
"version": "0.9.2",
3+
"version": "0.9.3",
44
"description": "A cross-browser object store library",
55
"author": "DataStack Team eleretzk@microsoft.com",
66
"scripts": {

src/InMemoryProvider.ts

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -150,13 +150,15 @@ export class InMemoryProvider extends DbProvider {
150150
return this._stores.get(name)!!!;
151151
}
152152

153-
// Overrides the base DbProvider.put() shortcut to expose InMemoryStore's indexNames scoping (see
154-
// InMemoryStore.put() for the full rationale). This is intentionally NOT part of the shared DbStore/
155-
// DbProvider interfaces: scoping which index(es) get populated only makes sense for an in-memory cache
156-
// that's re-derived from a real database, never for the database itself, which must always keep every
157-
// index consistent with the data it stores. Keeping it off the shared interfaces makes it a compile error
158-
// to pass indexNames to any other provider (e.g. IndexedDbProvider) -- callers must have a reference typed
159-
// as InMemoryProvider (not the generic DbProvider) to use this parameter at all.
153+
/**
154+
* Overrides the base DbProvider.put() shortcut to expose InMemoryStore's indexNames scoping (see
155+
* InMemoryStore.put() for the full rationale). This is intentionally NOT part of the shared DbStore/
156+
* DbProvider interfaces: scoping which index(es) get populated only makes sense for an in-memory cache
157+
* that's re-derived from a real database, never for the database itself, which must always keep every
158+
* index consistent with the data it stores. Keeping it off the shared interfaces makes it a compile error
159+
* to pass indexNames to any other provider (e.g. IndexedDbProvider) -- callers must have a reference typed
160+
* as InMemoryProvider (not the generic DbProvider) to use this parameter at all.
161+
*/
160162
put(
161163
storeName: string,
162164
itemOrItems: ItemType | ItemType[],

0 commit comments

Comments
 (0)