Interface: FolderAdapter
Defined in: packages/core/src/storage/folder-adapter.ts:58
Where a store keeps its bytes: entries by string key, and version bodies by id. Write one to keep a node's data somewhere new. The optional methods only save round trips.
Extends
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
namespace | readonly | string | Where inside the folder this adapter keeps its files | packages/core/src/storage/folder-adapter.ts:60 |
Methods
batch()
batch(ops): Promise<void>;Defined in: packages/core/src/types.ts:276
Applies these puts and deletes; should be atomic
Parameters
| Parameter | Type |
|---|---|
ops | readonly BatchOp[] |
Returns
Promise<void>
Inherited from
close()
close(): Promise<void>;Defined in: packages/core/src/types.ts:278
Releases it
Returns
Promise<void>
Inherited from
commit()?
commit?(write): Promise<void>;Defined in: packages/core/src/types.ts:288
Optional: stores these versions, applies these entry ops and deletes
these versions in one atomic write. Without it: putVersion each,
then batch, then deleteVersion each.
Parameters
| Parameter | Type |
|---|---|
write | { ops: readonly BatchOp[]; remove: readonly string[]; store: readonly Version<unknown>[]; } |
write.ops | readonly BatchOp[] |
write.remove | readonly string[] |
write.store | readonly Version<unknown>[] |
Returns
Promise<void>
Inherited from
delete()
delete(key): Promise<void>;Defined in: packages/core/src/types.ts:266
Removes an entry; absent is fine
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
Promise<void>
Inherited from
deleteVersion()
deleteVersion(id): Promise<void>;Defined in: packages/core/src/types.ts:274
Delete a version by ID
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
Promise<void>
Inherited from
entries()?
entries?(prefix): Promise<readonly (readonly [string, Uint8Array<ArrayBufferLike>])[]>;Defined in: packages/core/src/types.ts:280
Optional: every entry under a prefix with its value, in one read. Without it, list then get each.
Parameters
| Parameter | Type |
|---|---|
prefix | string |
Returns
Promise<readonly (readonly [string, Uint8Array<ArrayBufferLike>])[]>
Inherited from
get()
get(key): Promise<Uint8Array<ArrayBufferLike> | null>;Defined in: packages/core/src/types.ts:262
The entry's bytes, or null
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
Promise<Uint8Array<ArrayBufferLike> | null>
Inherited from
getVersion()
getVersion(id): Promise<Version<unknown> | null>;Defined in: packages/core/src/types.ts:272
Get a version by ID
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
Promise<Version<unknown> | null>
Inherited from
getVersions()?
getVersions?(ids): Promise<readonly (Version<unknown> | null)[]>;Defined in: packages/core/src/types.ts:282
Optional: many versions by id in one read, null where absent, in the order asked. Without it, getVersion each.
Parameters
| Parameter | Type |
|---|---|
ids | readonly string[] |
Returns
Promise<readonly (Version<unknown> | null)[]>
Inherited from
list()
list(prefix?): Promise<string[]>;Defined in: packages/core/src/types.ts:268
Every key starting with prefix, in any order
Parameters
| Parameter | Type |
|---|---|
prefix? | string |
Returns
Promise<string[]>
Inherited from
listVersionIds()
listVersionIds(): Promise<readonly string[]>;Defined in: packages/core/src/storage/folder-adapter.ts:67
Every version id currently on disk, whatever the entries believe
Returns
Promise<readonly string[]>
put()
put(key, value): Promise<void>;Defined in: packages/core/src/types.ts:264
Sets an entry
Parameters
| Parameter | Type |
|---|---|
key | string |
value | Uint8Array |
Returns
Promise<void>
Inherited from
putVersion()
putVersion(version): Promise<void>;Defined in: packages/core/src/types.ts:270
Store a version
Parameters
| Parameter | Type |
|---|---|
version | Version |
Returns
Promise<void>
Inherited from
reload()
reload(): Promise<FolderReload>;Defined in: packages/core/src/storage/folder-adapter.ts:65
Re-reads the directory, picking up writes made by another origin or device; the web has no change notification. Pair it with reconcileFolder.
Returns
Promise<FolderReload>