Class BaseStorage<K, V>`Abstract`

Type Parameters

K extends string
V

Hierarchy

BaseStorage
- LevelStorage

Index

Constructors

Properties

db path sublevels defaultOpts

Methods

clear close del exists findBoundingEntry findBoundingKey findBoundingValue get getDb getFirstEntry getFirstKey getFirstValue getLastEntry getLastKey getLastValue getMany put

Constructors

constructor

new BaseStorage<K, V>(path: string, db?: Level<K, V>): BaseStorage<K, V>
Type Parameters
- K extends string
- V
Parameters
- path: string
- db: Level<K, V> = ...
Returns BaseStorage<K, V>
- Defined in packages/core/src/storage/baseStorage.ts:36

Properties

`Protected` db

db: Level<K, V> = ...

`Protected` path

path: string

`Protected` sublevels

sublevels: Record<string, StorageLevel<K, V>> = {}

`Static` defaultOpts

defaultOpts: {
keyEncoding: string;
valueEncoding: string;
} = ...

Type declaration

keyEncoding: string
valueEncoding: string

Methods

clear

clear(options?: StorageCommonOptions): Promise<void>
Parameters
- Optional options: StorageCommonOptions
Returns Promise<void>
- Defined in packages/core/src/storage/baseStorage.ts:90

close

close(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/storage/baseStorage.ts:43

del

del(key: K, options?: StorageCommonOptions): Promise<void>
Parameters
- key: K
- Optional options: StorageCommonOptions
Returns Promise<void>
- Defined in packages/core/src/storage/baseStorage.ts:85

exists

exists(key: K, options?: StorageCommonOptions): Promise<boolean>
Parameters
- key: K
- Optional options: StorageCommonOptions
Returns Promise<boolean>
- Defined in packages/core/src/storage/baseStorage.ts:76

findBoundingEntry

findBoundingEntry(options?: StorageIteratorOptions<K, V>): Promise<undefined | StorageEntry<K, V>>
Parameters
- Optional options: StorageIteratorOptions<K, V>
Returns Promise<undefined | StorageEntry<K, V>>
- Defined in packages/core/src/storage/baseStorage.ts:119

findBoundingKey

findBoundingKey(options?: StorageKeyIteratorOptions<K>): Promise<undefined | K>
Parameters
- Optional options: StorageKeyIteratorOptions<K>
Returns Promise<undefined | K>
- Defined in packages/core/src/storage/baseStorage.ts:138

findBoundingValue

findBoundingValue(options?: StorageValueIteratorOptions<K, V>): Promise<undefined | V>
Parameters
- Optional options: StorageValueIteratorOptions<K, V>
Returns Promise<undefined | V>
- Defined in packages/core/src/storage/baseStorage.ts:149

get

get(key: K, options?: StorageCommonOptions): Promise<undefined | V>
Parameters
- key: K
- Optional options: StorageCommonOptions
Returns Promise<undefined | V>
- Defined in packages/core/src/storage/baseStorage.ts:61

`Protected` getDb

getDb(sublevel?: string): StorageLevel<K, V>
Parameters
- Optional sublevel: string
Returns StorageLevel<K, V>
- Defined in packages/core/src/storage/baseStorage.ts:47

getFirstEntry

getFirstEntry(): Promise<undefined | StorageEntry<K, V>>
Returns Promise<undefined | StorageEntry<K, V>>
- Defined in packages/core/src/storage/baseStorage.ts:99

getFirstKey

getFirstKey(): Promise<undefined | K>
Returns Promise<undefined | K>
- Defined in packages/core/src/storage/baseStorage.ts:107

getFirstValue

getFirstValue(): Promise<undefined | V>
Returns Promise<undefined | V>
- Defined in packages/core/src/storage/baseStorage.ts:115

getLastEntry

getLastEntry(): Promise<undefined | StorageEntry<K, V>>
Returns Promise<undefined | StorageEntry<K, V>>
- Defined in packages/core/src/storage/baseStorage.ts:95

getLastKey

getLastKey(): Promise<undefined | K>
Returns Promise<undefined | K>
- Defined in packages/core/src/storage/baseStorage.ts:103

getLastValue

getLastValue(): Promise<undefined | V>
Returns Promise<undefined | V>
- Defined in packages/core/src/storage/baseStorage.ts:111

getMany

getMany(keys: K[], options?: StorageCommonOptions): Promise<V[]>
Parameters
- keys: K[]
- Optional options: StorageCommonOptions
Returns Promise<V[]>
- Defined in packages/core/src/storage/baseStorage.ts:71

put

put(key: K, value: V, options?: StorageCommonOptions): Promise<void>
Parameters
- key: K
- value: V
- Optional options: StorageCommonOptions
Returns Promise<void>
- Defined in packages/core/src/storage/baseStorage.ts:80

Generated using TypeDoc