Class LevelMap<K, V, T>

AbstractLevel implementation of an async queryable map.

Type Parameters

K
V
T = any

Hierarchy

AsyncDisposableCloseable
- LevelMap

Implements

AsyncIterable<[K, V]>
MaybeAsyncMap<K, V>
MaybeAsyncMapBatch<K, V>
RangeQueryable<K, V>
Startable
AsyncDisposable

Index

Constructors

Properties

Accessors

[rangeQueryable] [toStringTag] started

Methods

[asyncDispose] [asyncIterator] clear close delete deleteMany entries get getMany has hasMany keys set setMany start updateMany values

Constructors

constructor

new LevelMap<K, V, T>(level): LevelMap<K, V, T>
Type Parameters
- K
- V
- T = any
Parameters
- level: AbstractLevel<T, K, V>
  Backing AbstractLevel storage.
Returns LevelMap<K, V, T>
Overrides AsyncDisposableCloseable.constructor
- Defined in plugins/level/src/map.ts:18

Properties

`Protected` `Readonly` level

level: AbstractLevel<T, K, V>

Backing AbstractLevel storage.

`Private` opened

opened: boolean

Accessors

[rangeQueryable]

get [rangeQueryable](): true
Marker to indicate that this object is a RangeQueryable.

Returns true
Implementation of RangeQueryable.[rangeQueryable]
- Defined in plugins/level/src/map.ts:174

[toStringTag]

get [toStringTag](): string
Returns string
- Defined in plugins/level/src/map.ts:170

started

get started(): boolean
Returns if this has started.

Returns boolean
Implementation of Startable.started
- Defined in plugins/level/src/map.ts:26

Methods

[asyncDispose]

[asyncDispose](): Promise<void>
Returns Promise<void>
Implementation of AsyncDisposable.[asyncDispose]
Inherited from AsyncDisposableCloseable.[asyncDispose]
- Defined in commons/dist/lifecycle/closeable.d.ts:15

[asyncIterator]

[asyncIterator](): AsyncIterableIterator<[K, V]>
Returns AsyncIterableIterator<[K, V]>
Implementation of AsyncIterable.[asyncIterator]
- Defined in plugins/level/src/map.ts:166

clear

clear(options?): Promise<void>
Clears the given range of entries or the entire store.
Parameters
- options: RangeQueryOptions<K> = {}
Returns Promise<void>
- Defined in plugins/level/src/map.ts:41

close

close(): Promise<void>
Closes this object and releases any system resource associated with it.

Returns Promise<void>
Implementation of Startable.close
Overrides AsyncDisposableCloseable.close
- Defined in plugins/level/src/map.ts:35

delete

delete(key): Promise<void>
Deletes an entry by key from the map. Returns MaybePromise<unknown> to be compatible with ES Map.
Parameters
- key: K
Returns Promise<void>
Implementation of MaybeAsyncMap.delete
- Defined in plugins/level/src/map.ts:60

deleteMany

deleteMany(keys): AsyncIterableIterator<undefined | CodedError<K, unknown>>
Deletes the values with given keys.
Parameters
- keys: Iterable<K>
Returns AsyncIterableIterator<undefined | CodedError<K, unknown>>
Implementation of MaybeAsyncMapBatch.deleteMany
- Defined in plugins/level/src/map.ts:100

entries

entries(options?): AsyncIterableIterator<[K, V]>
Queries key-value pairs by given criteria.
Parameters
- options: RangeQueryOptions<K> = {}
Returns AsyncIterableIterator<[K, V]>
Implementation of RangeQueryable.entries
- Defined in plugins/level/src/map.ts:160

get

get(key): Promise<undefined | V>
Gets a value by key from the map.
Parameters
- key: K
Returns Promise<undefined | V>
Implementation of MaybeAsyncMap.get
- Defined in plugins/level/src/map.ts:45

getMany

getMany(keys): AsyncIterableIterator<undefined | V>
Gets the list of data identified by given keys.
Parameters
- keys: Iterable<K>
Returns AsyncIterableIterator<undefined | V>
Implementation of MaybeAsyncMapBatch.getMany
- Defined in plugins/level/src/map.ts:68

has

has(key): Promise<boolean>
Returns whether a key exists in the map.
Parameters
- key: K
Returns Promise<boolean>
Implementation of MaybeAsyncMap.has
- Defined in plugins/level/src/map.ts:64

hasMany

hasMany(keys): AsyncIterableIterator<boolean>
Checks if given keys exist in the set.
Parameters
- keys: Iterable<K>
Returns AsyncIterableIterator<boolean>
Implementation of MaybeAsyncMapBatch.hasMany
- Defined in plugins/level/src/map.ts:72

keys

keys(options?): AsyncIterableIterator<K>
Queries keys by given criteria.
Parameters
- options: RangeQueryOptions<K> = {}
Returns AsyncIterableIterator<K>
Implementation of RangeQueryable.keys
- Defined in plugins/level/src/map.ts:148

set

set(key, value): Promise<void>
Sets an entry in the map. Returns MaybePromise<unknown> to be compatible with ES Map.
Parameters
- key: K
- value: V
Returns Promise<void>
Implementation of MaybeAsyncMap.set
- Defined in plugins/level/src/map.ts:56

setMany

setMany(entries): AsyncIterableIterator<undefined | CodedError<K, unknown>>
Sets given list of entries.
Parameters
- entries: Iterable<[K, V]>
Returns AsyncIterableIterator<undefined | CodedError<K, unknown>>
Implementation of MaybeAsyncMapBatch.setMany
- Defined in plugins/level/src/map.ts:78

start

start(options?): Promise<void>
Starts this component.
Parameters
- options: AbortOptions & AbstractOpenOptions = {}
Returns Promise<void>
Implementation of Startable.start
- Defined in plugins/level/src/map.ts:30

updateMany

updateMany(entries): AsyncIterableIterator<undefined | Error>
Sets or deletes given list of entries.
Parameters
- entries: Iterable<[K, V?]>
Returns AsyncIterableIterator<undefined | Error>
Implementation of MaybeAsyncMapBatch.updateMany
- Defined in plugins/level/src/map.ts:122

values

values(options?): AsyncIterableIterator<V>
Queries values by given criteria.
Parameters
- options: RangeQueryOptions<K> = {}
Returns AsyncIterableIterator<V>
Implementation of RangeQueryable.values
- Defined in plugins/level/src/map.ts:154

Generated using TypeDoc