Class DataStore

Data packet storage based on LevelDB or other abstract-leveldown store.

Hierarchy

TypedEventEmitter<Events, this>
- DataStore

Implements

Close
ListNames
ListData
Get
Find
Insert<InsertOptions>
Delete

Index

Constructors

Properties

Methods

clearExpired close delete find get insert listData listNames tx

Constructors

constructor

new DataStore(db): DataStore
Constructor.
Parameters
- db: AbstractLevelDOWN<any, any>
  
  an abstract-leveldown compatible store. It must support Buffer as keys.
Returns DataStore
Overrides (EventEmitter as new() => TypedEmitter<Events>).constructor
- Defined in packages/repo/src/data-store.ts:31

Properties

`Readonly` mutex

mutex: (<TResult, TArgs>(fn, ...args) => Promise<TResult>) = ...

Type declaration

- <TResult, TArgs>(fn, ...args): Promise<TResult>
- Create a throttle that only allows size calls in parallel. Extra calls will be queued until one of the earlier calls completes.
  
  To create an exclusive lock, just use a size of 1.
  Type Parameters
  - TResult
  - TArgs extends any[] = []
  Parameters
  - fn: ((...args) => Promise<TResult>)
    - (...args): Promise<TResult>
      
      Parameters
      
      Rest ...args: TArgs
      
      Returns Promise<TResult>
  - Rest ...args: TArgs
  Returns Promise<TResult>

Methods

clearExpired

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

Returns Promise<void>
- Defined in packages/repo/src/data-store.ts:124

close

close(): Promise<void>
Close the store.

Returns Promise<void>
Implementation of S.Close.close
- Defined in packages/repo/src/data-store.ts:37

delete

delete(...names): Promise<void>
Delete Data packets with given names.
Parameters
- Rest ...names: Name[]
Returns Promise<void>
Implementation of S.Delete.delete
- Defined in packages/repo/src/data-store.ts:115

find

find(interest): Promise<undefined | Data>
Find Data that satisfies Interest.
Parameters
- interest: Interest
Returns Promise<undefined | Data>
Implementation of S.Find.find
- Defined in packages/repo/src/data-store.ts:88

get

get(name): Promise<undefined | Data>
Retrieve Data by exact name.
Parameters
- name: Name
Returns Promise<undefined | Data>
Implementation of S.Get.get
- Defined in packages/repo/src/data-store.ts:71

insert

insert(...args): Promise<void>
Insert one or more Data packets.
Parameters
- Rest ...args: (Data | AnyIterable<Data>)[] | [InsertOptions, ...(Data | AnyIterable<Data>)[]]
Returns Promise<void>
Implementation of S.Insert.insert
- Defined in packages/repo/src/data-store.ts:105

listData

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

listNames

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

tx

tx(): Transaction
Start an update transaction.

Returns Transaction
- Defined in packages/repo/src/data-store.ts:100

Generated using TypeDoc