• ------------------------------
    • JS API Reference

    Module: shared/yagna/event-reader

    Table of contents

    Classes

    Type Aliases

    Type Aliases

    CancellablePoll

    Ƭ CancellablePoll<T>: Object

    Type parameters

    Name
    T

    Type declaration

    NameTypeDescription
    eventTypestringUser defined name of the event stream for ease of debugging
    isFinishedbooleanFlag indicating if the reader is finished and no longer polling
    pollValues() => AsyncGenerator<T>-
    cancel() => Promise<void>-

    Defined in

    src/shared/yagna/event-reader.ts:6

    CancellableEventsFetcherWithCursor

    Ƭ CancellableEventsFetcherWithCursor<T>: (lastEventTimestamp: string) => CancellablePromise<T[]>

    Type parameters

    NameType
    Textends EventDTO

    Type declaration

    ▸ (lastEventTimestamp): CancellablePromise<T[]>

    Parameters
    NameType
    lastEventTimestampstring
    Returns

    CancellablePromise<T[]>

    Defined in

    src/shared/yagna/event-reader.ts:23