Class PendingWorkStorage<T>

Defines the storage handler class for different entities.

Type Parameters

Hierarchy

EntityStorage<Utils.PendingWork<T>>
- PendingWorkStorage

Constructors

constructor

new PendingWorkStorage<T>(options: Utils.PendingWorkStorageOptions<T>): Utils.PendingWorkStorage<T>
Type Parameters
- T
Parameters
- options: Utils.PendingWorkStorageOptions<T>
Returns Utils.PendingWorkStorage<T>
Overrides EntityStorage.constructor
- Defined in packages/core/src/utils/concurrence/dal/pendingWork.ts:24

Properties

`Protected` StorageClass

StorageClass: typeof LevelStorage = LevelStorage

`Protected` atomicOpMutex

atomicOpMutex: Mutex

`Protected` byIndex

byIndex: Record<string, EntityIndexStorage<Utils.PendingWork<T>, Utils.PendingWork<T>>> = {}

`Protected` count

count: number = 0

`Protected` noopMutex

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

`Protected` options

options: EntityStorageOptions<Utils.PendingWork<T>>

`Protected` self

self: typeof EntityIndexStorage

`Protected` storage

storage: LevelStorage<string | Utils.PendingWork<T>> = ...

`Static` AddressLength

AddressLength: number = EntityIndexStorage.AddressLength

`Static` EthereumAddressLength

EthereumAddressLength: number = EntityIndexStorage.EthereumAddressLength

`Static` TimestampLength

TimestampLength: number = EntityIndexStorage.TimestampLength

`Static` VariableLength

VariableLength: number = EntityIndexStorage.VariableLength

`Static` keyValueDelimiter

keyValueDelimiter: string = '|'

Methods

backup

backup(): Promise<void>
Returns Promise<void>
Inherited from EntityStorage.backup
- 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>
Inherited from EntityStorage.exists
- Defined in packages/core/src/storage/entityIndexStorage.ts:364

`Protected` filterItem

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

`Protected` getAllSubkeysStartingFrom

getAllSubkeysStartingFrom(entity: Utils.PendingWork<T>, chunk?: number, prevSubkeys?: string[]): string[]
Parameters
- entity: Utils.PendingWork<T>
- chunk: number = 0
- prevSubkeys: string[] = []
Returns string[]
Inherited from EntityStorage.getAllSubkeysStartingFrom
- Defined in packages/core/src/storage/entityIndexStorage.ts:439

getAllValues

getAllValues(options?: EntityIndexStorageGetStreamOptions<Utils.PendingWork<T>>): Promise<StorageValueStream<Utils.PendingWork<T>>>
Parameters
- Optional options: EntityIndexStorageGetStreamOptions<Utils.PendingWork<T>>
Returns Promise<StorageValueStream<Utils.PendingWork<T>>>
Inherited from EntityStorage.getAllValues
- Defined in packages/core/src/storage/entityIndexStorage.ts:125

getAllValuesFromTo

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

`Protected` getAtomicOpMutex

getAtomicOpMutex(atomic?: boolean): Promise<(() => void)>
Parameters
- atomic: boolean = false
Returns Promise<(() => void)>
Inherited from EntityStorage.getAtomicOpMutex
- Defined in packages/core/src/storage/entityStorage.ts:210

getBatch

getBatch(): StorageBatch<string, string | Utils.PendingWork<T>>
Returns StorageBatch<string, string | Utils.PendingWork<T>>
Inherited from EntityStorage.getBatch
- Defined in packages/core/src/storage/entityIndexStorage.ts:108

getCount

getCount(options?: EntityIndexStorageInvokeOptions): Promise<number>
Parameters
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<number>
Inherited from EntityStorage.getCount
- 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>
Inherited from EntityStorage.getCountDelta
- Defined in packages/core/src/storage/entityIndexStorage.ts:636

`Protected` getEntityGroups

getEntityGroups(entities: Utils.PendingWork<T>[], op: EntityUpdateOp): Promise<{
toRemove: Utils.PendingWork<T>[];
toUpdate: Utils.PendingWork<T>[];
}>
Parameters
- entities: Utils.PendingWork<T>[]
- op: EntityUpdateOp
Returns Promise<{
toRemove: Utils.PendingWork<T>[];
toUpdate: Utils.PendingWork<T>[];
}>
Inherited from EntityStorage.getEntityGroups
- Defined in packages/core/src/storage/entityStorage.ts:170

getFirstItemFromTo

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

getFirstKey

getFirstKey(options?: EntityIndexStorageInvokeOptions): Promise<undefined | string>
Parameters
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<undefined | string>
Inherited from EntityStorage.getFirstKey
- 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>
Inherited from EntityStorage.getFirstKeyFromTo
- Defined in packages/core/src/storage/entityIndexStorage.ts:233

getFirstValue

getFirstValue(options?: EntityIndexStorageInvokeOptions): Promise<undefined | Utils.PendingWork<T>>
Parameters
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<undefined | Utils.PendingWork<T>>
Inherited from EntityStorage.getFirstValue
- Defined in packages/core/src/storage/entityIndexStorage.ts:144

getFirstValueFromTo

getFirstValueFromTo(start?: Stringifable[], end?: Stringifable[], options?: EntityIndexStorageInvokeOptions): Promise<undefined | Utils.PendingWork<T>>
Parameters
- Optional start: Stringifable[]
- Optional end: Stringifable[]
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<undefined | Utils.PendingWork<T>>
Inherited from EntityStorage.getFirstValueFromTo
- 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
Inherited from EntityStorage.getKeyChunk
- Defined in packages/core/src/storage/entityIndexStorage.ts:481

getKeys

getKeys(entity: Utils.PendingWork<T>): string[]
Parameters
- entity: Utils.PendingWork<T>
Returns string[]
Inherited from EntityStorage.getKeys
- Defined in packages/core/src/storage/entityIndexStorage.ts:435

getLastItemFromTo

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

getLastKey

getLastKey(options?: EntityIndexStorageInvokeOptions): Promise<undefined | string>
Parameters
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<undefined | string>
Inherited from EntityStorage.getLastKey
- 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>
Inherited from EntityStorage.getLastKeyFromTo
- Defined in packages/core/src/storage/entityIndexStorage.ts:281

getLastValue

getLastValue(options?: EntityIndexStorageInvokeOptions): Promise<undefined | Utils.PendingWork<T>>
Parameters
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<undefined | Utils.PendingWork<T>>
Inherited from EntityStorage.getLastValue
- Defined in packages/core/src/storage/entityIndexStorage.ts:150

getLastValueFromTo

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

getMany

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

`Protected` getValue

getValue(entity: Utils.PendingWork<T>): string | Utils.PendingWork<T>
Parameters
- entity: Utils.PendingWork<T>
Returns string | Utils.PendingWork<T>
Inherited from EntityStorage.getValue
- Defined in packages/core/src/storage/entityIndexStorage.ts:517

init

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

`Protected` mapItem

mapItem(options: undefined | EntityIndexStorageInvokeOptions, item: StorageEntry<string, string | Utils.PendingWork<T>>): Promise<undefined | StorageEntry<string, Utils.PendingWork<T>>>
Parameters
- options: undefined | EntityIndexStorageInvokeOptions
- item: StorageEntry<string, string | Utils.PendingWork<T>>
Returns Promise<undefined | StorageEntry<string, Utils.PendingWork<T>>>
Inherited from EntityStorage.mapItem
- Defined in packages/core/src/storage/entityIndexStorage.ts:555

`Protected` mapItemToKey

mapItemToKey(item: StorageEntry<string, Utils.PendingWork<T>>): string
Parameters
- item: StorageEntry<string, Utils.PendingWork<T>>
Returns string
Inherited from EntityStorage.mapItemToKey
- Defined in packages/core/src/storage/entityIndexStorage.ts:624

`Protected` mapItemToValue

mapItemToValue(item: StorageEntry<string, Utils.PendingWork<T>>): Utils.PendingWork<T>
Parameters
- item: StorageEntry<string, Utils.PendingWork<T>>
Returns Utils.PendingWork<T>
Inherited from EntityStorage.mapItemToValue
- Defined in packages/core/src/storage/entityIndexStorage.ts:628

`Protected` mapItems

mapItems(stream: StorageStream<string, string | Utils.PendingWork<T>>, options: StorageCommonOptions): StorageStream<string, Utils.PendingWork<T>>
Parameters
- stream: StorageStream<string, string | Utils.PendingWork<T>>
- options: StorageCommonOptions
Returns StorageStream<string, Utils.PendingWork<T>>
Inherited from EntityStorage.mapItems
- 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[]
Inherited from EntityStorage.mapKeyChunks
- Defined in packages/core/src/storage/entityIndexStorage.ts:529

`Protected` mapManyItem

mapManyItem(options: undefined | EntityIndexStorageGetStreamOptions<Utils.PendingWork<T>>, items: StorageEntry<string, string | Utils.PendingWork<T>>[]): Promise<StorageEntry<string, Utils.PendingWork<T>>[]>
Parameters
- options: undefined | EntityIndexStorageGetStreamOptions<Utils.PendingWork<T>>
- items: StorageEntry<string, string | Utils.PendingWork<T>>[]
Returns Promise<StorageEntry<string, Utils.PendingWork<T>>[]>
Inherited from EntityStorage.mapManyItem
- Defined in packages/core/src/storage/entityIndexStorage.ts:589

remove

remove(entities: Utils.PendingWork<T> | Utils.PendingWork<T>[]): Promise<void>
Parameters
- entities: Utils.PendingWork<T> | Utils.PendingWork<T>[]
Returns Promise<void>
Inherited from EntityStorage.remove
- Defined in packages/core/src/storage/entityStorage.ts:135

restore

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

save

save(entities: Utils.PendingWork<T> | Utils.PendingWork<T>[]): Promise<void>
Parameters
- entities: Utils.PendingWork<T> | Utils.PendingWork<T>[]
Returns Promise<void>
Inherited from EntityStorage.save
- Defined in packages/core/src/storage/entityStorage.ts:99

useIndex

useIndex(indexName?: string): EntityIndexStorage<Utils.PendingWork<T>, Utils.PendingWork<T>>
Parameters
- Optional indexName: string
Returns EntityIndexStorage<Utils.PendingWork<T>, Utils.PendingWork<T>>
Inherited from EntityStorage.useIndex
- Defined in packages/core/src/storage/entityStorage.ts:88

Class PendingWorkStorage<T>

Type Parameters

T

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T

Parameters

options: Utils.PendingWorkStorageOptions<T>

Returns Utils.PendingWorkStorage<T>

Properties

Protected StorageClass

Protected atomicOpMutex

Protected byIndex

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, Utils.PendingWork<T>>

Returns Promise<boolean>

get

Parameters

key: string | Stringifable[]

Optional options: EntityIndexStorageInvokeOptions

Returns Promise<undefined | Utils.PendingWork<T>>

getAll

Parameters

Optional options: EntityIndexStorageGetStreamOptions<Utils.PendingWork<T>>

Returns Promise<StorageStream<string, Utils.PendingWork<T>>>

getAllFromTo

Parameters

Optional start: Stringifable[]

Optional end: Stringifable[]

options: EntityIndexStorageGetStreamOptions<Utils.PendingWork<T>> = ...

Returns Promise<StorageStream<string, Utils.PendingWork<T>>>

getAllKeys

Parameters

Optional options: EntityIndexStorageGetStreamOptions<Utils.PendingWork<T>>

Returns Promise<StorageKeyStream<string>>

getAllKeysFromTo

Parameters

Optional start: Stringifable[]

Optional end: Stringifable[]

Optional options: EntityIndexStorageGetStreamOptions<Utils.PendingWork<T>>

Returns Promise<StorageKeyStream<string>>

Protected getAllSubkeysStartingFrom

Parameters

entity: Utils.PendingWork<T>

chunk: number = 0

prevSubkeys: string[] = []

Returns string[]

getAllValues

Parameters

Optional options: EntityIndexStorageGetStreamOptions<Utils.PendingWork<T>>

Returns Promise<StorageValueStream<Utils.PendingWork<T>>>

getAllValuesFromTo

Parameters

Optional start: Stringifable[]

Optional end: Stringifable[]

`Protected` StorageClass

`Protected` atomicOpMutex

`Protected` byIndex

`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<Utils.PendingWork<T>>

`Optional` start: Stringifable[]

`Optional` end: Stringifable[]

`Optional` options: EntityIndexStorageGetStreamOptions<Utils.PendingWork<T>>

`Optional` start: Stringifable[]

`Optional` end: Stringifable[]

`Optional` options: EntityIndexStorageGetStreamOptions<Utils.PendingWork<T>>

`Protected` getAllSubkeysStartingFrom

`Optional` options: EntityIndexStorageGetStreamOptions<Utils.PendingWork<T>>

`Optional` start: Stringifable[]

`Optional` end: Stringifable[]

`Optional` options: EntityIndexStorageGetStreamOptions<Utils.PendingWork<T>>

`Protected` getAtomicOpMutex

`Optional` options: EntityIndexStorageInvokeOptions

`Protected` getCountDelta

`Optional` fixedCount: number

`Protected` getEntityGroups

Returns Promise<{
toRemove: Utils.PendingWork<T>[];
toUpdate: Utils.PendingWork<T>[];
}>

`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