Class EntityIndexStorage<Entity, Returned>

Type Parameters

Entity
Returned extends Entity | string = string

Hierarchy

EntityIndexStorage
- EntityStorage

Constructors

constructor

new EntityIndexStorage<Entity, Returned>(options: EntityIndexStorageOptions<Entity>, atomicOpMutex?: Mutex, storage?: LevelStorage<string | Entity>): EntityIndexStorage<Entity, Returned>
Type Parameters
- Entity
- Returned = string
Parameters
- options: EntityIndexStorageOptions<Entity>
- atomicOpMutex: Mutex = ...
- storage: LevelStorage<string | Entity> = ...
Returns EntityIndexStorage<Entity, Returned>
- Defined in packages/core/src/storage/entityIndexStorage.ts:68

Properties

`Protected` atomicOpMutex

atomicOpMutex: Mutex = ...

`Protected` count

count: number = 0

`Protected` noopMutex

noopMutex: Promise<(() => void)> = ...

`Protected` options

options: EntityIndexStorageOptions<Entity>

`Protected` self

self: typeof EntityIndexStorage

`Protected` storage

storage: LevelStorage<string | Entity> = ...

`Static` AddressLength

AddressLength: number = 44

`Static` EthereumAddressLength

EthereumAddressLength: number = 42

`Static` TimestampLength

TimestampLength: number = 13

`Static` VariableLength

VariableLength: number = 0

`Static` keyValueDelimiter

keyValueDelimiter: string = '|'

Methods

backup

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

exists

exists(key: string, options?: EntityIndexStorageInvokeOptions): Promise<boolean>
Parameters
- key: string
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<boolean>
- Defined in packages/core/src/storage/entityIndexStorage.ts:364

`Protected` filterItem

filterItem(item: undefined | StorageEntry<string, Entity>): Promise<boolean>
Parameters
- item: undefined | StorageEntry<string, Entity>
Returns Promise<boolean>
- Defined in packages/core/src/storage/entityIndexStorage.ts:618

get

get(key: string | Stringifable[], options?: EntityIndexStorageInvokeOptions): Promise<undefined | Returned>
Parameters
- key: string | Stringifable[]
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<undefined | Returned>
- Defined in packages/core/src/storage/entityIndexStorage.ts:299

getAll

getAll(options?: EntityIndexStorageGetStreamOptions<Returned>): Promise<StorageStream<string, Returned>>
Parameters
- Optional options: EntityIndexStorageGetStreamOptions<Returned>
Returns Promise<StorageStream<string, Returned>>
- Defined in packages/core/src/storage/entityIndexStorage.ts:112

getAllFromTo

getAllFromTo(start?: Stringifable[], end?: Stringifable[], options?: EntityIndexStorageGetStreamOptions<Returned>): Promise<StorageStream<string, Returned>>
Parameters
- Optional start: Stringifable[]
- Optional end: Stringifable[]
- options: EntityIndexStorageGetStreamOptions<Returned> = ...
Returns Promise<StorageStream<string, Returned>>
- Defined in packages/core/src/storage/entityIndexStorage.ts:156

getAllKeys

getAllKeys(options?: EntityIndexStorageGetStreamOptions<Returned>): Promise<StorageKeyStream<string>>
Parameters
- Optional options: EntityIndexStorageGetStreamOptions<Returned>
Returns Promise<StorageKeyStream<string>>
- Defined in packages/core/src/storage/entityIndexStorage.ts:118

getAllKeysFromTo

getAllKeysFromTo(start?: Stringifable[], end?: Stringifable[], options?: EntityIndexStorageGetStreamOptions<Returned>): Promise<StorageKeyStream<string>>
Parameters
- Optional start: Stringifable[]
- Optional end: Stringifable[]
- Optional options: EntityIndexStorageGetStreamOptions<Returned>
Returns Promise<StorageKeyStream<string>>
- Defined in packages/core/src/storage/entityIndexStorage.ts:185

`Protected` getAllSubkeysStartingFrom

getAllSubkeysStartingFrom(entity: Entity, chunk?: number, prevSubkeys?: string[]): string[]
Parameters
- entity: Entity
- chunk: number = 0
- prevSubkeys: string[] = []
Returns string[]
- Defined in packages/core/src/storage/entityIndexStorage.ts:439

getAllValues

getAllValues(options?: EntityIndexStorageGetStreamOptions<Returned>): Promise<StorageValueStream<Returned>>
Parameters
- Optional options: EntityIndexStorageGetStreamOptions<Returned>
Returns Promise<StorageValueStream<Returned>>
- Defined in packages/core/src/storage/entityIndexStorage.ts:125

getAllValuesFromTo

getAllValuesFromTo(start?: Stringifable[], end?: Stringifable[], options?: EntityIndexStorageGetStreamOptions<Returned>): Promise<StorageValueStream<Returned>>
Parameters
- Optional start: Stringifable[]
- Optional end: Stringifable[]
- Optional options: EntityIndexStorageGetStreamOptions<Returned>
Returns Promise<StorageValueStream<Returned>>
- Defined in packages/core/src/storage/entityIndexStorage.ts:194

`Protected` getAtomicOpMutex

getAtomicOpMutex(atomic?: boolean): Promise<(() => void)>
Parameters
- atomic: boolean = false
Returns Promise<(() => void)>
- Defined in packages/core/src/storage/entityIndexStorage.ts:632

getBatch

getBatch(): StorageBatch<string, string | Entity>
Returns StorageBatch<string, string | Entity>
- Defined in packages/core/src/storage/entityIndexStorage.ts:108

getCount

getCount(options?: EntityIndexStorageInvokeOptions): Promise<number>
Parameters
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<number>
- Defined in packages/core/src/storage/entityIndexStorage.ts:96

`Protected` getCountDelta

getCountDelta(items: string[], isDelete: boolean, fixedCount?: number): Promise<number>
Parameters
- items: string[]
- isDelete: boolean
- Optional fixedCount: number
Returns Promise<number>
- Defined in packages/core/src/storage/entityIndexStorage.ts:636

getFirstItemFromTo

getFirstItemFromTo(start?: Stringifable[], end?: Stringifable[], options?: EntityIndexStorageInvokeOptions): Promise<undefined | StorageEntry<string, Returned>>
Parameters
- Optional start: Stringifable[]
- Optional end: Stringifable[]
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<undefined | StorageEntry<string, Returned>>
- Defined in packages/core/src/storage/entityIndexStorage.ts:203

getFirstKey

getFirstKey(options?: EntityIndexStorageInvokeOptions): Promise<undefined | string>
Parameters
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<undefined | string>
- Defined in packages/core/src/storage/entityIndexStorage.ts:132

getFirstKeyFromTo

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

getFirstValue

getFirstValue(options?: EntityIndexStorageInvokeOptions): Promise<undefined | Returned>
Parameters
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<undefined | Returned>
- Defined in packages/core/src/storage/entityIndexStorage.ts:144

getFirstValueFromTo

getFirstValueFromTo(start?: Stringifable[], end?: Stringifable[], options?: EntityIndexStorageInvokeOptions): Promise<undefined | Returned>
Parameters
- Optional start: Stringifable[]
- Optional end: Stringifable[]
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<undefined | Returned>
- Defined in packages/core/src/storage/entityIndexStorage.ts:242

`Protected` getKeyChunk

getKeyChunk(key: Stringifable, chunk?: number): undefined | string
Parameters
- key: Stringifable
- chunk: number = 0
Returns undefined | string
- Defined in packages/core/src/storage/entityIndexStorage.ts:481

getKeys

getKeys(entity: Entity): string[]
Parameters
- entity: Entity
Returns string[]
- Defined in packages/core/src/storage/entityIndexStorage.ts:435

getLastItemFromTo

getLastItemFromTo(start?: Stringifable[], end?: Stringifable[], options?: EntityIndexStorageInvokeOptions): Promise<undefined | StorageEntry<string, Returned>>
Parameters
- Optional start: Stringifable[]
- Optional end: Stringifable[]
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<undefined | StorageEntry<string, Returned>>
- Defined in packages/core/src/storage/entityIndexStorage.ts:251

getLastKey

getLastKey(options?: EntityIndexStorageInvokeOptions): Promise<undefined | string>
Parameters
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<undefined | string>
- Defined in packages/core/src/storage/entityIndexStorage.ts:138

getLastKeyFromTo

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

getLastValue

getLastValue(options?: EntityIndexStorageInvokeOptions): Promise<undefined | Returned>
Parameters
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<undefined | Returned>
- Defined in packages/core/src/storage/entityIndexStorage.ts:150

getLastValueFromTo

getLastValueFromTo(start?: Stringifable[], end?: Stringifable[], options?: EntityIndexStorageInvokeOptions): Promise<undefined | Returned>
Parameters
- Optional start: Stringifable[]
- Optional end: Stringifable[]
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<undefined | Returned>
- Defined in packages/core/src/storage/entityIndexStorage.ts:290

getMany

getMany(keys: string[] | Stringifable[][], options?: EntityIndexStorageInvokeOptions): Promise<Returned[]>
Parameters
- keys: string[] | Stringifable[][]
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<Returned[]>
- Defined in packages/core/src/storage/entityIndexStorage.ts:334

`Protected` getValue

getValue(entity: Entity): string | Entity
Parameters
- entity: Entity
Returns string | Entity
- Defined in packages/core/src/storage/entityIndexStorage.ts:517

init

init(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/storage/entityIndexStorage.ts:80

`Protected` mapItem

mapItem(options: undefined | EntityIndexStorageInvokeOptions, item: StorageEntry<string, string | Entity>): Promise<undefined | StorageEntry<string, Returned>>
Parameters
- options: undefined | EntityIndexStorageInvokeOptions
- item: StorageEntry<string, string | Entity>
Returns Promise<undefined | StorageEntry<string, Returned>>
- Defined in packages/core/src/storage/entityIndexStorage.ts:555

`Protected` mapItemToKey

mapItemToKey(item: StorageEntry<string, Returned>): string
Parameters
- item: StorageEntry<string, Returned>
Returns string
- Defined in packages/core/src/storage/entityIndexStorage.ts:624

`Protected` mapItemToValue

mapItemToValue(item: StorageEntry<string, Returned>): Returned
Parameters
- item: StorageEntry<string, Returned>
Returns Returned
- Defined in packages/core/src/storage/entityIndexStorage.ts:628

`Protected` mapItems

mapItems(stream: StorageStream<string, string | Entity>, options: StorageCommonOptions): StorageStream<string, Returned>
Parameters
- stream: StorageStream<string, string | Entity>
- options: StorageCommonOptions
Returns StorageStream<string, Returned>
- Defined in packages/core/src/storage/entityIndexStorage.ts:546

`Protected` mapKeyChunks

mapKeyChunks(chunks?: Stringifable[], isEnd?: boolean): undefined | string[]
Parameters
- Optional chunks: Stringifable[]
- isEnd: boolean = false
Returns undefined | string[]
- Defined in packages/core/src/storage/entityIndexStorage.ts:529

`Protected` mapManyItem

mapManyItem(options: undefined | EntityIndexStorageGetStreamOptions<Returned>, items: StorageEntry<string, string | Entity>[]): Promise<StorageEntry<string, Returned>[]>
Parameters
- options: undefined | EntityIndexStorageGetStreamOptions<Returned>
- items: StorageEntry<string, string | Entity>[]
Returns Promise<StorageEntry<string, Returned>[]>
- Defined in packages/core/src/storage/entityIndexStorage.ts:589

remove

remove(entities: Entity | Entity[], options?: EntityIndexStorageRemoveOptions<string | Entity>): Promise<void>
Parameters
- entities: Entity | Entity[]
- Optional options: EntityIndexStorageRemoveOptions<string | Entity>
Returns Promise<void>
- Defined in packages/core/src/storage/entityIndexStorage.ts:409

restore

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

save

save(entities: Entity | Entity[], options?: EntityIndexStorageSaveOptions<string | Entity>): Promise<void>
Parameters
- entities: Entity | Entity[]
- Optional options: EntityIndexStorageSaveOptions<string | Entity>
Returns Promise<void>
- Defined in packages/core/src/storage/entityIndexStorage.ts:377

Class EntityIndexStorage<Entity, Returned>

Type Parameters

Entity

Returned extends Entity | string = string

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Entity

Returned = string

Parameters

options: EntityIndexStorageOptions<Entity>

atomicOpMutex: Mutex = ...

storage: LevelStorage<string | Entity> = ...

Returns EntityIndexStorage<Entity, Returned>

Properties

Protected atomicOpMutex

Protected count

Protected noopMutex

Protected options

Protected self

Protected storage

Static AddressLength

Static EthereumAddressLength

Static TimestampLength

Static VariableLength

Static keyValueDelimiter

Methods

backup

Returns Promise<void>

exists

Parameters

key: string

Optional options: EntityIndexStorageInvokeOptions

Returns Promise<boolean>

Protected filterItem

Parameters

item: undefined | StorageEntry<string, Entity>

Returns Promise<boolean>

get

Parameters

key: string | Stringifable[]

Optional options: EntityIndexStorageInvokeOptions

Returns Promise<undefined | Returned>

getAll

Parameters

Optional options: EntityIndexStorageGetStreamOptions<Returned>

Returns Promise<StorageStream<string, Returned>>

getAllFromTo

Parameters

Optional start: Stringifable[]

Optional end: Stringifable[]

options: EntityIndexStorageGetStreamOptions<Returned> = ...

Returns Promise<StorageStream<string, Returned>>

getAllKeys

Parameters

Optional options: EntityIndexStorageGetStreamOptions<Returned>

Returns Promise<StorageKeyStream<string>>

getAllKeysFromTo

Parameters

Optional start: Stringifable[]

Optional end: Stringifable[]

Optional options: EntityIndexStorageGetStreamOptions<Returned>

Returns Promise<StorageKeyStream<string>>

Protected getAllSubkeysStartingFrom

Parameters

entity: Entity

chunk: number = 0

prevSubkeys: string[] = []

Returns string[]

getAllValues

Parameters

Optional options: EntityIndexStorageGetStreamOptions<Returned>

Returns Promise<StorageValueStream<Returned>>

getAllValuesFromTo

Parameters

`Protected` atomicOpMutex

`Protected` count

`Protected` noopMutex

`Protected` options

`Protected` self

`Protected` storage

`Static` AddressLength

`Static` EthereumAddressLength

`Static` TimestampLength

`Static` VariableLength

`Static` keyValueDelimiter

`Optional` options: EntityIndexStorageInvokeOptions

`Protected` filterItem

`Optional` options: EntityIndexStorageInvokeOptions

`Optional` options: EntityIndexStorageGetStreamOptions<Returned>

`Optional` start: Stringifable[]

`Optional` end: Stringifable[]

`Optional` options: EntityIndexStorageGetStreamOptions<Returned>

`Optional` start: Stringifable[]

`Optional` end: Stringifable[]

`Optional` options: EntityIndexStorageGetStreamOptions<Returned>

`Protected` getAllSubkeysStartingFrom

`Optional` options: EntityIndexStorageGetStreamOptions<Returned>

`Optional` start: Stringifable[]

`Optional` end: Stringifable[]

`Optional` options: EntityIndexStorageGetStreamOptions<Returned>

`Protected` getAtomicOpMutex

`Optional` options: EntityIndexStorageInvokeOptions

`Protected` getCountDelta

`Optional` fixedCount: number

`Optional` start: Stringifable[]

`Optional` end: Stringifable[]

`Optional` options: EntityIndexStorageInvokeOptions

`Optional` options: EntityIndexStorageInvokeOptions

`Optional` start: Stringifable[]

`Optional` end: Stringifable[]

`Optional` options: EntityIndexStorageInvokeOptions

`Optional` options: EntityIndexStorageInvokeOptions

`Optional` start: Stringifable[]

`Optional` end: Stringifable[]

`Optional` options: EntityIndexStorageInvokeOptions

`Protected` getKeyChunk

`Optional` start: Stringifable[]

`Optional` end: Stringifable[]

`Optional` options: EntityIndexStorageInvokeOptions

`Optional` options: EntityIndexStorageInvokeOptions

`Optional` start: Stringifable[]

`Optional` end: Stringifable[]

`Optional` options: EntityIndexStorageInvokeOptions