Class FetcherStateLevelStorage<C>

Type Parameters

C = any

Hierarchy

EntityIndexStorage<BaseFetcherState<C>, BaseFetcherState<C>>
- FetcherStateLevelStorage

Constructors

constructor

new FetcherStateLevelStorage<C>(options: FetcherStateLevelStorageOptions<C>): FetcherStateLevelStorage<C>
Type Parameters
- C = any
Parameters
- options: FetcherStateLevelStorageOptions<C>
Returns FetcherStateLevelStorage<C>
Overrides EntityIndexStorage< BaseFetcherState<C>, BaseFetcherState<C> >.constructor
- Defined in packages/framework/src/services/fetcher/src/dal/fetcherState.ts:18

Properties

`Protected` atomicOpMutex

atomicOpMutex: Mutex

`Protected` count

count: number

`Protected` noopMutex

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

`Protected` options

options: EntityIndexStorageOptions<BaseFetcherState<C>>

`Protected` self

self: typeof EntityIndexStorage

`Protected` storage

storage: LevelStorage<string | BaseFetcherState<C>>

`Static` AddressLength

AddressLength: number

`Static` EthereumAddressLength

EthereumAddressLength: number

`Static` TimestampLength

TimestampLength: number

`Static` VariableLength

VariableLength: number

`Static` keyValueDelimiter

keyValueDelimiter: string

Methods

backup

backup(): Promise<void>
Returns Promise<void>
Inherited from EntityIndexStorage.backup
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:71

exists

exists(key: string, options?: EntityIndexStorageInvokeOptions): Promise<boolean>
Parameters
- key: string
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<boolean>
Inherited from EntityIndexStorage.exists
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:55

`Protected` filterItem

filterItem(item: undefined | StorageEntry<string, BaseFetcherState<C>>): Promise<boolean>
Parameters
- item: undefined | StorageEntry<string, BaseFetcherState<C>>
Returns Promise<boolean>
Inherited from EntityIndexStorage.filterItem
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:66

get

get(key: string | Stringifable[], options?: EntityIndexStorageInvokeOptions): Promise<undefined | BaseFetcherState<C>>
Parameters
- key: string | Stringifable[]
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<undefined | BaseFetcherState<C>>
Inherited from EntityIndexStorage.get
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:53

getAll

getAll(options?: EntityIndexStorageGetStreamOptions<BaseFetcherState<C>>): Promise<StorageStream<string, BaseFetcherState<C>>>
Parameters
- Optional options: EntityIndexStorageGetStreamOptions<BaseFetcherState<C>>
Returns Promise<StorageStream<string, BaseFetcherState<C>>>
Inherited from EntityIndexStorage.getAll
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:37

getAllFromTo

getAllFromTo(start?: Stringifable[], end?: Stringifable[], options?: EntityIndexStorageGetStreamOptions<BaseFetcherState<C>>): Promise<StorageStream<string, BaseFetcherState<C>>>
Parameters
- Optional start: Stringifable[]
- Optional end: Stringifable[]
- Optional options: EntityIndexStorageGetStreamOptions<BaseFetcherState<C>>
Returns Promise<StorageStream<string, BaseFetcherState<C>>>
Inherited from EntityIndexStorage.getAllFromTo
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:44

getAllKeys

getAllKeys(options?: EntityIndexStorageGetStreamOptions<BaseFetcherState<C>>): Promise<StorageKeyStream<string>>
Parameters
- Optional options: EntityIndexStorageGetStreamOptions<BaseFetcherState<C>>
Returns Promise<StorageKeyStream<string>>
Inherited from EntityIndexStorage.getAllKeys
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:38

getAllKeysFromTo

getAllKeysFromTo(start?: Stringifable[], end?: Stringifable[], options?: EntityIndexStorageGetStreamOptions<BaseFetcherState<C>>): Promise<StorageKeyStream<string>>
Parameters
- Optional start: Stringifable[]
- Optional end: Stringifable[]
- Optional options: EntityIndexStorageGetStreamOptions<BaseFetcherState<C>>
Returns Promise<StorageKeyStream<string>>
Inherited from EntityIndexStorage.getAllKeysFromTo
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:45

`Protected` getAllSubkeysStartingFrom

getAllSubkeysStartingFrom(entity: BaseFetcherState<C>, chunk?: number, prevSubkeys?: string[]): string[]
Parameters
- entity: BaseFetcherState<C>
- Optional chunk: number
- Optional prevSubkeys: string[]
Returns string[]
Inherited from EntityIndexStorage.getAllSubkeysStartingFrom
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:59

getAllValues

getAllValues(options?: EntityIndexStorageGetStreamOptions<BaseFetcherState<C>>): Promise<StorageValueStream<BaseFetcherState<C>>>
Parameters
- Optional options: EntityIndexStorageGetStreamOptions<BaseFetcherState<C>>
Returns Promise<StorageValueStream<BaseFetcherState<C>>>
Inherited from EntityIndexStorage.getAllValues
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:39

getAllValuesFromTo

getAllValuesFromTo(start?: Stringifable[], end?: Stringifable[], options?: EntityIndexStorageGetStreamOptions<BaseFetcherState<C>>): Promise<StorageValueStream<BaseFetcherState<C>>>
Parameters
- Optional start: Stringifable[]
- Optional end: Stringifable[]
- Optional options: EntityIndexStorageGetStreamOptions<BaseFetcherState<C>>
Returns Promise<StorageValueStream<BaseFetcherState<C>>>
Inherited from EntityIndexStorage.getAllValuesFromTo
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:46

`Protected` getAtomicOpMutex

getAtomicOpMutex(atomic?: boolean): Promise<(() => void)>
Parameters
- Optional atomic: boolean
Returns Promise<(() => void)>
Inherited from EntityIndexStorage.getAtomicOpMutex
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:69

getBatch

getBatch(): StorageBatch<string, string | BaseFetcherState<C>>
Returns StorageBatch<string, string | BaseFetcherState<C>>
Inherited from EntityIndexStorage.getBatch
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:36

getCount

getCount(options?: EntityIndexStorageInvokeOptions): Promise<number>
Parameters
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<number>
Inherited from EntityIndexStorage.getCount
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:35

`Protected` getCountDelta

getCountDelta(items: string[], isDelete: boolean, fixedCount?: number): Promise<number>
Parameters
- items: string[]
- isDelete: boolean
- Optional fixedCount: number
Returns Promise<number>
Inherited from EntityIndexStorage.getCountDelta
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:70

getFirstItemFromTo

getFirstItemFromTo(start?: Stringifable[], end?: Stringifable[], options?: EntityIndexStorageInvokeOptions): Promise<undefined | StorageEntry<string, BaseFetcherState<C>>>
Parameters
- Optional start: Stringifable[]
- Optional end: Stringifable[]
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<undefined | StorageEntry<string, BaseFetcherState<C>>>
Inherited from EntityIndexStorage.getFirstItemFromTo
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:47

getFirstKey

getFirstKey(options?: EntityIndexStorageInvokeOptions): Promise<undefined | string>
Parameters
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<undefined | string>
Inherited from EntityIndexStorage.getFirstKey
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:40

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 EntityIndexStorage.getFirstKeyFromTo
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:48

getFirstValue

getFirstValue(options?: EntityIndexStorageInvokeOptions): Promise<undefined | BaseFetcherState<C>>
Parameters
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<undefined | BaseFetcherState<C>>
Inherited from EntityIndexStorage.getFirstValue
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:42

getFirstValueFromTo

getFirstValueFromTo(start?: Stringifable[], end?: Stringifable[], options?: EntityIndexStorageInvokeOptions): Promise<undefined | BaseFetcherState<C>>
Parameters
- Optional start: Stringifable[]
- Optional end: Stringifable[]
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<undefined | BaseFetcherState<C>>
Inherited from EntityIndexStorage.getFirstValueFromTo
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:49

`Protected` getKeyChunk

getKeyChunk(key: Stringifable, chunk?: number): undefined | string
Parameters
- key: Stringifable
- Optional chunk: number
Returns undefined | string
Inherited from EntityIndexStorage.getKeyChunk
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:60

getKeys

getKeys(entity: BaseFetcherState<C>): string[]
Parameters
- entity: BaseFetcherState<C>
Returns string[]
Inherited from EntityIndexStorage.getKeys
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:58

getLastItemFromTo

getLastItemFromTo(start?: Stringifable[], end?: Stringifable[], options?: EntityIndexStorageInvokeOptions): Promise<undefined | StorageEntry<string, BaseFetcherState<C>>>
Parameters
- Optional start: Stringifable[]
- Optional end: Stringifable[]
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<undefined | StorageEntry<string, BaseFetcherState<C>>>
Inherited from EntityIndexStorage.getLastItemFromTo
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:50

getLastKey

getLastKey(options?: EntityIndexStorageInvokeOptions): Promise<undefined | string>
Parameters
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<undefined | string>
Inherited from EntityIndexStorage.getLastKey
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:41

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 EntityIndexStorage.getLastKeyFromTo
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:51

getLastValue

getLastValue(options?: EntityIndexStorageInvokeOptions): Promise<undefined | BaseFetcherState<C>>
Parameters
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<undefined | BaseFetcherState<C>>
Inherited from EntityIndexStorage.getLastValue
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:43

getLastValueFromTo

getLastValueFromTo(start?: Stringifable[], end?: Stringifable[], options?: EntityIndexStorageInvokeOptions): Promise<undefined | BaseFetcherState<C>>
Parameters
- Optional start: Stringifable[]
- Optional end: Stringifable[]
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<undefined | BaseFetcherState<C>>
Inherited from EntityIndexStorage.getLastValueFromTo
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:52

getMany

getMany(keys: string[] | Stringifable[][], options?: EntityIndexStorageInvokeOptions): Promise<BaseFetcherState<C>[]>
Parameters
- keys: string[] | Stringifable[][]
- Optional options: EntityIndexStorageInvokeOptions
Returns Promise<BaseFetcherState<C>[]>
Inherited from EntityIndexStorage.getMany
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:54

`Protected` getValue

getValue(entity: BaseFetcherState<C>): string | BaseFetcherState<C>
Parameters
- entity: BaseFetcherState<C>
Returns string | BaseFetcherState<C>
Inherited from EntityIndexStorage.getValue
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:61

init

init(): Promise<void>
Returns Promise<void>
Inherited from EntityIndexStorage.init
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:34

`Protected` mapItem

mapItem(options: undefined | EntityIndexStorageInvokeOptions, item: StorageEntry<string, string | BaseFetcherState<C>>): Promise<undefined | StorageEntry<string, BaseFetcherState<C>>>
Parameters
- options: undefined | EntityIndexStorageInvokeOptions
- item: StorageEntry<string, string | BaseFetcherState<C>>
Returns Promise<undefined | StorageEntry<string, BaseFetcherState<C>>>
Inherited from EntityIndexStorage.mapItem
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:64

`Protected` mapItemToKey

mapItemToKey(item: StorageEntry<string, BaseFetcherState<C>>): string
Parameters
- item: StorageEntry<string, BaseFetcherState<C>>
Returns string
Inherited from EntityIndexStorage.mapItemToKey
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:67

`Protected` mapItemToValue

mapItemToValue(item: StorageEntry<string, BaseFetcherState<C>>): BaseFetcherState<C>
Parameters
- item: StorageEntry<string, BaseFetcherState<C>>
Returns BaseFetcherState<C>
Inherited from EntityIndexStorage.mapItemToValue
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:68

`Protected` mapItems

mapItems(stream: StorageStream<string, string | BaseFetcherState<C>>, options: StorageCommonOptions): StorageStream<string, BaseFetcherState<C>>
Parameters
- stream: StorageStream<string, string | BaseFetcherState<C>>
- options: StorageCommonOptions
Returns StorageStream<string, BaseFetcherState<C>>
Inherited from EntityIndexStorage.mapItems
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:63

`Protected` mapKeyChunks

mapKeyChunks(chunks?: Stringifable[], isEnd?: boolean): undefined | string[]
Parameters
- Optional chunks: Stringifable[]
- Optional isEnd: boolean
Returns undefined | string[]
Inherited from EntityIndexStorage.mapKeyChunks
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:62

`Protected` mapManyItem

mapManyItem(options: undefined | EntityIndexStorageGetStreamOptions<BaseFetcherState<C>>, items: StorageEntry<string, string | BaseFetcherState<C>>[]): Promise<StorageEntry<string, BaseFetcherState<C>>[]>
Parameters
- options: undefined | EntityIndexStorageGetStreamOptions<BaseFetcherState<C>>
- items: StorageEntry<string, string | BaseFetcherState<C>>[]
Returns Promise<StorageEntry<string, BaseFetcherState<C>>[]>
Inherited from EntityIndexStorage.mapManyItem
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:65

remove

remove(entities: BaseFetcherState<C> | BaseFetcherState<C>[], options?: EntityIndexStorageRemoveOptions<string | BaseFetcherState<C>>): Promise<void>
Parameters
- entities: BaseFetcherState<C> | BaseFetcherState<C>[]
- Optional options: EntityIndexStorageRemoveOptions<string | BaseFetcherState<C>>
Returns Promise<void>
Inherited from EntityIndexStorage.remove
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:57

restore

restore(): Promise<boolean>
Returns Promise<boolean>
Inherited from EntityIndexStorage.restore
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:72

save

save(entities: BaseFetcherState<C> | BaseFetcherState<C>[], options?: EntityIndexStorageSaveOptions<string | BaseFetcherState<C>>): Promise<void>
Parameters
- entities: BaseFetcherState<C> | BaseFetcherState<C>[]
- Optional options: EntityIndexStorageSaveOptions<string | BaseFetcherState<C>>
Returns Promise<void>
Inherited from EntityIndexStorage.save
- Defined in packages/core/dist/storage/entityIndexStorage.d.ts:56

Class FetcherStateLevelStorage<C>

Type Parameters

C = any

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

C = any

Parameters

options: FetcherStateLevelStorageOptions<C>

Returns FetcherStateLevelStorage<C>

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, BaseFetcherState<C>>

Returns Promise<boolean>

get

Parameters

key: string | Stringifable[]

Optional options: EntityIndexStorageInvokeOptions

Returns Promise<undefined | BaseFetcherState<C>>

getAll

Parameters

Optional options: EntityIndexStorageGetStreamOptions<BaseFetcherState<C>>

Returns Promise<StorageStream<string, BaseFetcherState<C>>>

getAllFromTo

Parameters

Optional start: Stringifable[]

Optional end: Stringifable[]

Optional options: EntityIndexStorageGetStreamOptions<BaseFetcherState<C>>

Returns Promise<StorageStream<string, BaseFetcherState<C>>>

getAllKeys

Parameters

Optional options: EntityIndexStorageGetStreamOptions<BaseFetcherState<C>>

Returns Promise<StorageKeyStream<string>>

getAllKeysFromTo

Parameters

Optional start: Stringifable[]

Optional end: Stringifable[]

Optional options: EntityIndexStorageGetStreamOptions<BaseFetcherState<C>>

Returns Promise<StorageKeyStream<string>>

Protected getAllSubkeysStartingFrom

Parameters

entity: BaseFetcherState<C>

Optional chunk: number

Optional prevSubkeys: string[]

Returns string[]

getAllValues

Parameters

Optional options: EntityIndexStorageGetStreamOptions<BaseFetcherState<C>>

Returns Promise<StorageValueStream<BaseFetcherState<C>>>

getAllValuesFromTo

Parameters

Optional start: Stringifable[]

Optional end: Stringifable[]

Optional options: EntityIndexStorageGetStreamOptions<BaseFetcherState<C>>

Returns Promise<StorageValueStream<BaseFetcherState<C>>>

`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<BaseFetcherState<C>>

`Optional` start: Stringifable[]

`Optional` end: Stringifable[]

`Optional` options: EntityIndexStorageGetStreamOptions<BaseFetcherState<C>>

`Optional` options: EntityIndexStorageGetStreamOptions<BaseFetcherState<C>>

`Optional` start: Stringifable[]

`Optional` end: Stringifable[]

`Optional` options: EntityIndexStorageGetStreamOptions<BaseFetcherState<C>>

`Protected` getAllSubkeysStartingFrom

`Optional` chunk: number

`Optional` prevSubkeys: string[]

`Optional` options: EntityIndexStorageGetStreamOptions<BaseFetcherState<C>>

`Optional` start: Stringifable[]

`Optional` end: Stringifable[]

`Optional` options: EntityIndexStorageGetStreamOptions<BaseFetcherState<C>>

`Protected` getAtomicOpMutex

`Optional` atomic: boolean

`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` chunk: 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