Class DataStore

Data packet storage based on LevelDB or other abstract-level compatible key-value database.

Remarks

Create an instance with makeInMemoryDataStore or makePersistentDataStore.

Hierarchy

TypedEventTarget<EventMap>
- DataStore

Implements

Index

Properties

[kMaybeHaveEventListener] mutex

Methods

[asyncDispose] clearExpired delete find get insert listData listNames tx create

Properties

`Readonly` [kMaybeHaveEventListener]

[kMaybeHaveEventListener]: Record<string, boolean> = ...

`Readonly` mutex

mutex: Mutex = ...

Methods

[asyncDispose]

[asyncDispose](): Promise<void>
Close the store.

Returns Promise<void>
Implementation of AsyncDisposable.[asyncDispose]
- Defined in data-store.ts:68

clearExpired

clearExpired(): Promise<void>
Delete all expired records.

Returns Promise<void>
- Defined in data-store.ts:162

delete

delete(...names): Promise<void>
Delete Data packets with given names.
Parameters
- Rest ...names: readonly Name[]
Returns Promise<void>
See
Transaction.delete
Implementation of Delete.delete
- Defined in data-store.ts:152

find

find(interest): Promise<undefined | Data>
Find Data that satisfies Interest.
Parameters
- interest: Interest
Returns Promise<undefined | Data>
Implementation of Find.find
- Defined in data-store.ts:118

get

get(name): Promise<undefined | Data>
Retrieve Data by exact name.
Parameters
- name: Name
Returns Promise<undefined | Data>
Implementation of Get.get
- Defined in data-store.ts:103

insert

insert(...args): Promise<void>
Insert one or more Data packets.
Parameters
- Rest ...args: (Data | AnyIterable<Data>)[] | [InsertOptions, ...(Data | AnyIterable<Data>)[]]
Returns Promise<void>
See
Transaction.insert
Implementation of Insert.insert
- Defined in data-store.ts:138

listData

listData(prefix?): AsyncIterable<Data>
List Data packets, optionally filtered by name prefix.
Parameters
- Optional prefix: Name
Returns AsyncIterable<Data>
Implementation of ListData.listData
- Defined in data-store.ts:94

listNames

listNames(prefix?): AsyncIterable<Name>
List Data names, optionally filtered by name prefix.
Parameters
- Optional prefix: Name
Returns AsyncIterable<Name>
Implementation of ListNames.listNames
- Defined in data-store.ts:85

tx

tx(): Transaction
Start an update transaction.

Returns Transaction
- Defined in data-store.ts:130

`Static` create

create(open): Promise<DataStore>
Create DataStore from an abstract-level opener function.
Parameters
- open: DbOpener
  Function that opens an abstract-level compatible key-value database with the given options.
Returns Promise<DataStore>
- Defined in data-store.ts:32
create<const A, const O>(ctor, ...args): Promise<DataStore>
Create DataStore from an abstract-level subclass constructor.
Type Parameters
- const A extends unknown[]
- const O extends {}
Parameters
- ctor: DbCtor<A, O>
  Subclass of abstract-level that accepts options as its last parameter.
- Rest ...args: [...A[], O]
  ctor arguments; last should be options object.
Returns Promise<DataStore>
- Defined in data-store.ts:39