Class DenoKVMap<K, V>

Deno Kv implementation of an async queryable map.

Type Parameters

K extends KvKey = KvKey
V = unknown

Hierarchy

DisposableCloseable
- DenoKVMap

Implements

AsyncIterable<[K, V]>
MaybeAsyncMap<K, V>
MaybeAsyncMapBatch<K, V>
RangeQueryable<K, V>
Disposable

Index

Constructors

Properties

Accessors

[rangeQueryable] [toStringTag]

Methods

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

Constructors

constructor

new DenoKVMap<K, V>(kv, consistency?): DenoKVMap<K, V>
Type Parameters
- K extends KvKey = KvKey
- V = unknown
Parameters
- kv: Kv
  Backing Kv storage.
- consistency: KvConsistencyLevel = 'strong'
  Default consistency level for get operations.
Returns DenoKVMap<K, V>
Overrides DisposableCloseable.constructor
- Defined in plugins/denokv/src/map.ts:12

Properties

`Protected` `Readonly` consistency

consistency: KvConsistencyLevel = 'strong'

Default consistency level for get operations.

`Protected` `Readonly` kv

kv: Kv

Backing Kv storage.

Accessors

[rangeQueryable]

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

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

[toStringTag]

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

Methods

[asyncIterator]

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

[dispose]

[dispose](): void
Returns void
Implementation of Disposable.[dispose]
Inherited from DisposableCloseable.[dispose]
- Defined in commons/dist/lifecycle/closeable.d.ts:10

close

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

Returns void
Overrides DisposableCloseable.close
- Defined in plugins/denokv/src/map.ts:21

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/denokv/src/map.ts:34

deleteMany

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

entries

entries(options?): AsyncIterableIterator<[K, V]>
Queries key-value pairs by given criteria.
Parameters
- Optional options: DenoKVMapRangeQueryOptions<K>
Returns AsyncIterableIterator<[K, V]>
Implementation of RangeQueryable.entries
- Defined in plugins/denokv/src/map.ts:113

get

get<T>(key, options?): Promise<undefined | T>
Gets a value by key from the map.
Type Parameters
- T = V
Parameters
- key: K
- Optional options: DenoKVMapGetOptions
Returns Promise<undefined | T>
Implementation of MaybeAsyncMap.get
- Defined in plugins/denokv/src/map.ts:25

getMany

getMany<T>(keys, options?): AsyncIterableIterator<undefined | T>
Gets the list of data identified by given keys.
Type Parameters
- T = V
Parameters
- keys: Iterable<K>
- Optional options: DenoKVMapGetOptions
Returns AsyncIterableIterator<undefined | T>
Implementation of MaybeAsyncMapBatch.getMany
- Defined in plugins/denokv/src/map.ts:42

has

has(key, options?): Promise<boolean>
Returns whether a key exists in the map.
Parameters
- key: K
- Optional options: DenoKVMapGetOptions
Returns Promise<boolean>
Implementation of MaybeAsyncMap.has
- Defined in plugins/denokv/src/map.ts:38

hasMany

hasMany(keys, options?): AsyncIterableIterator<boolean>
Checks if given keys exist in the set.
Parameters
- keys: Iterable<K>
- Optional options: DenoKVMapGetOptions
Returns AsyncIterableIterator<boolean>
Implementation of MaybeAsyncMapBatch.hasMany
- Defined in plugins/denokv/src/map.ts:53

keys

keys(options?): AsyncIterableIterator<K>
Queries keys by given criteria.
Parameters
- Optional options: DenoKVMapRangeQueryOptions<K>
Returns AsyncIterableIterator<K>
Implementation of RangeQueryable.keys
- Defined in plugins/denokv/src/map.ts:101

set

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

setMany

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

updateMany

updateMany(entries, options?): AsyncIterableIterator<undefined | CodedError<K, unknown>>
Sets or deletes given list of entries.
Parameters
- entries: Iterable<[K, V?]>
- Optional options: DenoKVMapSetOptions
Returns AsyncIterableIterator<undefined | CodedError<K, unknown>>
Implementation of MaybeAsyncMapBatch.updateMany
- Defined in plugins/denokv/src/map.ts:71

values

values(options?): AsyncIterableIterator<V>
Queries values by given criteria.
Parameters
- Optional options: DenoKVMapRangeQueryOptions<K>
Returns AsyncIterableIterator<V>
Implementation of RangeQueryable.values
- Defined in plugins/denokv/src/map.ts:107

Generated using TypeDoc