Skip to content

EventIterator

Extends

  • EventIterator

Methods

getBook()

getBook(): Book;

Gets the Book that originated the iterator

Returns

Book

The Book object

Inherited from

Bkper.EventIterator.getBook

getContinuationToken()

getContinuationToken(): string;

Gets a token that can be used to resume this iteration at a later time.

This method is useful if processing an iterator in one execution would exceed the maximum execution time.

Continuation tokens are generally valid short period of time.

Returns

string

The continuation token

Inherited from

Bkper.EventIterator.getContinuationToken

hasNext()

hasNext(): boolean;

Determines whether calling next() will return a transaction.

Returns

boolean

Inherited from

Bkper.EventIterator.hasNext

next()

next(): Event;

Gets the next event in the collection of events.

Returns

Event

The next Event object

Inherited from

Bkper.EventIterator.next

setContinuationToken()

setContinuationToken(continuationToken): void;

Sets a continuation token from a previous paused iteration.

Parameters

ParameterType
continuationTokenstring

Returns

void

Inherited from

Bkper.EventIterator.setContinuationToken