OpfsEffects
Defined in: packages/client/src/opfs-effects.ts:48
The effects surface the store-boot wiring drives (create-if-absent / delete-if-present / never-creating observe).
Methods
Section titled “Methods”deleteSentinel()
Section titled “deleteSentinel()”deleteSentinel():
Promise<void>
Defined in: packages/client/src/opfs-effects.ts:55
Delete-if-present the commitment sentinel (NotFoundError swallowed). A root that cannot be opened at all
raises OpfsRootUnavailableError.
Returns
Section titled “Returns”Promise<void>
deleteStoreDirectory()
Section titled “deleteStoreDirectory()”deleteStoreDirectory():
Promise<void>
Defined in: packages/client/src/opfs-effects.ts:62
Recursively delete-if-present the store directory pgxsinkit/stores/<identity> (NotFoundError swallowed),
under the store’s ownership lock: the delete waits (bounded) until the context holding the directory’s
sync-access handles has released them, and fails with StoreOwnershipWaitError under a live owner. A root
that cannot be opened at all raises OpfsRootUnavailableError.
Returns
Section titled “Returns”Promise<void>
getStoreDirectoryHandle()
Section titled “getStoreDirectoryHandle()”getStoreDirectoryHandle():
Promise<unknown>
Defined in: packages/client/src/opfs-effects.ts:69
Create-if-absent chain to the store directory, returning its handle for the opfs-repacked factory.
Returns
Section titled “Returns”Promise<unknown>
observeCommitmentNamespace()
Section titled “observeCommitmentNamespace()”observeCommitmentNamespace():
Promise<{sentinelPresent:boolean;storeDirectoryPresent:boolean; } |"unobservable">
Defined in: packages/client/src/opfs-effects.ts:67
Never-creating walk of the commitment namespace. A root/API failure (or the API being absent) reads as
"unobservable" — this method NEVER throws.
Returns
Section titled “Returns”Promise<{ sentinelPresent: boolean; storeDirectoryPresent: boolean; } | "unobservable">
publishSentinel()
Section titled “publishSentinel()”publishSentinel():
Promise<void>
Defined in: packages/client/src/opfs-effects.ts:50
Create-if-absent the commitment sentinel file at pgxsinkit/commitments/<identity>.
Returns
Section titled “Returns”Promise<void>