Class LevelStorage<V>

Type Parameters

Hierarchy

BaseStorage<string, V>
- LevelStorage

Constructors

constructor

new LevelStorage<V>(options: LevelStorageOptions<V>, db?: Level<string, V>): LevelStorage<V>
Type Parameters
- V
Parameters
- options: LevelStorageOptions<V>
- Optional db: Level<string, V>
Returns LevelStorage<V>
Overrides BaseStorage.constructor
- Defined in packages/core/src/storage/levelStorage.ts:78

Properties

`Protected` backupPath

backupPath: string

`Protected` db

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

`Protected` path

path: string

`Protected` self

self: typeof LevelStorage

`Protected` sublevels

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

`Static` defaultOpts

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

Type declaration

keyEncoding: string
valueEncoding: string

`Static` keyChunkDelimiter

keyChunkDelimiter: string = ':'

`Static` maxChar

maxChar: string = '~'

`Static` minChar

minChar: string = '!'

Methods

backup

backup(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/storage/levelStorage.ts:406

clear

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

close

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

composeKey

composeKey(key: string | string[]): string
Parameters
- key: string | string[]
Returns string
- Defined in packages/core/src/storage/levelStorage.ts:103

`Protected` debugFromTo

debugFromTo(name: string, fromToOpts: any, options?: StorageCommonOptions): void
Parameters
- name: string
- fromToOpts: any
- Optional options: StorageCommonOptions
Returns void
- Defined in packages/core/src/storage/levelStorage.ts:458

del

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

exists

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

findBoundingEntry

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

`Protected` findBoundingItemFromTo

findBoundingItemFromTo(start?: string | string[], end?: string | string[], options?: StorageGetOptions<string, V>): Promise<undefined | StorageEntry<string, V>>
Parameters
- Optional start: string | string[]
- Optional end: string | string[]
- options: StorageGetOptions<string, V> = ...
Returns Promise<undefined | StorageEntry<string, V>>
- Defined in packages/core/src/storage/levelStorage.ts:333

findBoundingKey

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

`Protected` findBoundingKeyFromTo

findBoundingKeyFromTo(start?: string | string[], end?: string | string[], options?: StorageGetOptions<string, V>): Promise<undefined | string>
Parameters
- Optional start: string | string[]
- Optional end: string | string[]
- Optional options: StorageGetOptions<string, V>
Returns Promise<undefined | string>
- Defined in packages/core/src/storage/levelStorage.ts:349

findBoundingValue

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

`Protected` findBoundingValueFromTo

findBoundingValueFromTo(start?: string | string[], end?: string | string[], options?: StorageGetOptions<string, V>): Promise<undefined | V>
Parameters
- Optional start: string | string[]
- Optional end: string | string[]
- Optional options: StorageGetOptions<string, V>
Returns Promise<undefined | V>
- Defined in packages/core/src/storage/levelStorage.ts:367

get

get(key: string | string[], options?: StorageCommonOptions): Promise<undefined | V>
Parameters
- key: string | string[]
- Optional options: StorageCommonOptions
Returns Promise<undefined | V>
Overrides BaseStorage.get
- Defined in packages/core/src/storage/levelStorage.ts:111

getAll

getAll(options?: StorageGetOptions<string, V>): StorageStream<string, V>
Parameters
- options: StorageGetOptions<string, V> = ...
Returns StorageStream<string, V>
- Defined in packages/core/src/storage/levelStorage.ts:140

getAllFromTo

getAllFromTo(start?: string | string[], end?: string | string[], options?: StorageGetOptions<string, V>): StorageStream<string, V>
Parameters
- Optional start: string | string[]
- Optional end: string | string[]
- options: StorageGetOptions<string, V> = ...
Returns StorageStream<string, V>
- Defined in packages/core/src/storage/levelStorage.ts:240

getAllKeys

getAllKeys(options?: StorageGetOptions<string, V>): StorageKeyStream<string>
Parameters
- Optional options: StorageGetOptions<string, V>
Returns StorageKeyStream<string>
- Defined in packages/core/src/storage/levelStorage.ts:161

getAllKeysFromTo

getAllKeysFromTo(start?: string | string[], end?: string | string[], options?: StorageGetOptions<string, V>): StorageKeyStream<string>
Parameters
- Optional start: string | string[]
- Optional end: string | string[]
- Optional options: StorageGetOptions<string, V>
Returns StorageKeyStream<string>
- Defined in packages/core/src/storage/levelStorage.ts:250

getAllValues

getAllValues(options?: StorageGetOptions<string, V>): StorageValueStream<V>
Parameters
- Optional options: StorageGetOptions<string, V>
Returns StorageValueStream<V>
- Defined in packages/core/src/storage/levelStorage.ts:182

getAllValuesFromTo

getAllValuesFromTo(start?: string | string[], end?: string | string[], options?: StorageGetOptions<string, V>): StorageValueStream<V>
Parameters
- Optional start: string | string[]
- Optional end: string | string[]
- Optional options: StorageGetOptions<string, V>
Returns StorageValueStream<V>
- Defined in packages/core/src/storage/levelStorage.ts:260

getBatch

getBatch(): StorageBatch<string, V>
Returns StorageBatch<string, V>
- Defined in packages/core/src/storage/levelStorage.ts:107

`Protected` getDb

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

getFirstEntry

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

getFirstItemFromTo

getFirstItemFromTo(start?: string | string[], end?: string | string[], options?: StorageCommonOptions): Promise<undefined | StorageEntry<string, V>>
Parameters
- Optional start: string | string[]
- Optional end: string | string[]
- Optional options: StorageCommonOptions
Returns Promise<undefined | StorageEntry<string, V>>
- Defined in packages/core/src/storage/levelStorage.ts:270

getFirstKey

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

getFirstKeyFromTo

getFirstKeyFromTo(start?: string | string[], end?: string | string[], options?: StorageCommonOptions): Promise<undefined | string>
Parameters
- Optional start: string | string[]
- Optional end: string | string[]
- Optional options: StorageCommonOptions
Returns Promise<undefined | string>
- Defined in packages/core/src/storage/levelStorage.ts:281

getFirstValue

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

getFirstValueFromTo

getFirstValueFromTo(start?: string | string[], end?: string | string[], options?: StorageCommonOptions): Promise<undefined | V>
Parameters
- Optional start: string | string[]
- Optional end: string | string[]
- Optional options: StorageCommonOptions
Returns Promise<undefined | V>
- Defined in packages/core/src/storage/levelStorage.ts:292

`Protected` getFromToFilters

getFromToFilters(start?: string | string[], end?: string | string[]): {
gte?: string;
lt?: string;
}
Parameters
- Optional start: string | string[]
- Optional end: string | string[]
Returns {
gte?: string;
lt?: string;
}
- Optional gte?: string
- Optional lt?: string
- Defined in packages/core/src/storage/levelStorage.ts:386

getLastEntry

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

getLastItemFromTo

getLastItemFromTo(start?: string | string[], end?: string | string[], options?: StorageCommonOptions): Promise<undefined | StorageEntry<string, V>>
Parameters
- Optional start: string | string[]
- Optional end: string | string[]
- Optional options: StorageCommonOptions
Returns Promise<undefined | StorageEntry<string, V>>
- Defined in packages/core/src/storage/levelStorage.ts:303

getLastKey

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

getLastKeyFromTo

getLastKeyFromTo(start?: string | string[], end?: string | string[], options?: StorageCommonOptions): Promise<undefined | string>
Parameters
- Optional start: string | string[]
- Optional end: string | string[]
- Optional options: StorageCommonOptions
Returns Promise<undefined | string>
- Defined in packages/core/src/storage/levelStorage.ts:314

getLastValue

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

getLastValueFromTo

getLastValueFromTo(start?: string | string[], end?: string | string[], options?: StorageCommonOptions): Promise<undefined | V>
Parameters
- Optional start: string | string[]
- Optional end: string | string[]
- Optional options: StorageCommonOptions
Returns Promise<undefined | V>
- Defined in packages/core/src/storage/levelStorage.ts:322

getMany

getMany(keys: string[], options?: StorageCommonOptions): Promise<V[]>
Parameters
- keys: string[]
- Optional options: StorageCommonOptions
Returns Promise<V[]>
Overrides BaseStorage.getMany
- Defined in packages/core/src/storage/levelStorage.ts:127

put

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

remove

remove(keys: (string | string[])[], options?: StoragePutOptions<string, V>): Promise<void>
Parameters
- keys: (string | string[])[]
- Optional options: StoragePutOptions<string, V>
Returns Promise<void>
- Defined in packages/core/src/storage/levelStorage.ts:221

restore

restore(): Promise<boolean>
Returns Promise<boolean>
- Defined in packages/core/src/storage/levelStorage.ts:430

save

save(entries: StorageEntry<string | string[], V>[], options?: StoragePutOptions<string, V>): Promise<void>
Parameters
- entries: StorageEntry<string | string[], V>[]
- Optional options: StoragePutOptions<string, V>
Returns Promise<void>
- Defined in packages/core/src/storage/levelStorage.ts:203

Class LevelStorage<V>

Type Parameters

V

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

V

Parameters

options: LevelStorageOptions<V>

Optional db: Level<string, V>

Returns LevelStorage<V>

Properties

Protected backupPath

Protected db

Protected Optional filterFn

Protected Optional mapFn

Protected options

Protected path

Protected self

Protected sublevels

Static defaultOpts

Type declaration

keyEncoding: string

valueEncoding: string

Static keyChunkDelimiter

Static maxChar

Static minChar

Methods

backup

Returns Promise<void>

clear

Parameters

Optional options: StorageCommonOptions

Returns Promise<void>

close

Returns Promise<void>

composeKey

Parameters

key: string | string[]

Returns string

Protected debugFromTo

Parameters

name: string

fromToOpts: any

Optional options: StorageCommonOptions

Returns void

del

Parameters

key: string

Optional options: StorageCommonOptions

Returns Promise<void>

exists

Parameters

key: string

Optional options: StorageCommonOptions

Returns Promise<boolean>

findBoundingEntry

Parameters

Optional options: StorageIteratorOptions<string, V>

Returns Promise<undefined | StorageEntry<string, V>>

Protected findBoundingItemFromTo

Parameters

Optional start: string | string[]

Optional end: string | string[]

options: StorageGetOptions<string, V> = ...

Returns Promise<undefined | StorageEntry<string, V>>

findBoundingKey

Parameters

Optional options: StorageKeyIteratorOptions<string>

Returns Promise<undefined | string>

Protected findBoundingKeyFromTo

Parameters

Optional start: string | string[]

Optional end: string | string[]

Optional options: StorageGetOptions<string, V>

`Optional` db: Level<string, V>

`Protected` backupPath

`Protected` db

`Protected` `Optional` filterFn

`Protected` `Optional` mapFn

`Protected` options

`Protected` path

`Protected` self

`Protected` sublevels

`Static` defaultOpts

`Static` keyChunkDelimiter

`Static` maxChar

`Static` minChar

`Optional` options: StorageCommonOptions

`Protected` debugFromTo

`Optional` options: StorageCommonOptions

`Optional` options: StorageCommonOptions

`Optional` options: StorageCommonOptions

`Optional` options: StorageIteratorOptions<string, V>

`Protected` findBoundingItemFromTo

`Optional` start: string | string[]

`Optional` end: string | string[]

`Optional` options: StorageKeyIteratorOptions<string>

`Protected` findBoundingKeyFromTo

`Optional` start: string | string[]

`Optional` end: string | string[]

`Optional` options: StorageGetOptions<string, V>

`Optional` options: StorageValueIteratorOptions<string, V>

`Protected` findBoundingValueFromTo

`Optional` start: string | string[]

`Optional` end: string | string[]

`Optional` options: StorageGetOptions<string, V>

`Optional` options: StorageCommonOptions

`Optional` start: string | string[]

`Optional` end: string | string[]

`Optional` options: StorageGetOptions<string, V>

`Optional` start: string | string[]

`Optional` end: string | string[]

`Optional` options: StorageGetOptions<string, V>

`Optional` options: StorageGetOptions<string, V>

`Optional` start: string | string[]

`Optional` end: string | string[]

`Optional` options: StorageGetOptions<string, V>

`Protected` getDb

`Optional` sublevel: string

`Optional` start: string | string[]

`Optional` end: string | string[]

`Optional` options: StorageCommonOptions

`Optional` start: string | string[]

`Optional` end: string | string[]

`Optional` options: StorageCommonOptions