Class default

This is a cache for aching raw channel elements

When calling init() only number of 'batchSize' elements are loaded. Loading further elements is done when calling loadNextBatch.

Updating the cache happens for two reasons:

we want to grab more elements (loadNextBatch) -> load next batchSize elements.

use the previously stored iterator

the history changed and we want to update oly messages before the last loaded element -> time parameter

iterate the new iterator up to a point where the history matches with the cache
iterate the remaining elements from the cache (faster - because the same)

Index

Constructors

Properties

onError onUpdate

Methods

cachedEntries init loadNextBatch shutdown

Constructors

constructor

new default(
    channelManager: default,
    channelId: string,
    owner: undefined | SHA256IdHash<Person>,
    batchSize: number,
): default
Constructor
Parameters
- channelManager: default
  The channelmanager used to access the channel.
- channelId: string
  The channelId of the channel to iterate.
- owner: undefined | SHA256IdHash<Person>
  The owner of the channel to iterate.
- batchSize: number
  The number of messages to load as one batch. Load the next batch with loadNextBatch().
Returns default
- Defined in api/utils/caches/RawChannelEntriesCache.ts:43

Properties

onError

onError: OEvent<(error: any) => void> = ...

onUpdate

onUpdate: OEvent<(newMessages: boolean) => void> = ...

Methods

cachedEntries

cachedEntries(): RawChannelEntry[]
Get the cached entries synchronously.

Returns RawChannelEntry[]
- Defined in api/utils/caches/RawChannelEntriesCache.ts:143

init

init(): void
Initialize the instance.

Returns void
- Defined in api/utils/caches/RawChannelEntriesCache.ts:58

loadNextBatch

loadNextBatch(): void
Loads the next batch of messages.

Returns void
- Defined in api/utils/caches/RawChannelEntriesCache.ts:89

shutdown

shutdown(): void
Cleanup the instance.

Returns void
- Defined in api/utils/caches/RawChannelEntriesCache.ts:78