Class Events

Events is an API to stream updates from an ipfs pubsub

Hierarchy

API
- Events

Index

Constructors

constructor

Methods

Constructors

constructor

new Events(opts?: ApiOptions): Events

Overrides API.__constructor
- Defined in modules/events.ts:27
Parameters
- Default value opts: ApiOptions = DEFAULT_API_OPTIONS
Returns Events

Methods

addPubsubQueryResultListener

addPubsubQueryResultListener(listener: function, queryId: string, queryHandle: EventSource | ReadableStream<ArrayBuffer>): ReadableStream<ArrayBuffer> | EventSubscription

- Defined in modules/events.ts:35
Parameters
- listener: function
  - - (queryId: string, message: string, messageId: string): void
    - Parameters
      - queryId: string
      - message: string
      - messageId: string
      Returns void
- queryId: string
- queryHandle: EventSource | ReadableStream<ArrayBuffer>
Returns ReadableStream<ArrayBuffer> | EventSubscription

addQueryDoneListener

addQueryDoneListener(listener: function, queryId: string): EventSubscription

- Defined in modules/events.ts:178
Parameters
- listener: function
  - - (queryId: string): void
    - Parameters
      - queryId: string
      Returns void
- queryId: string
Returns EventSubscription

addQueryErrorListener

addQueryErrorListener(listener: function, queryId: string): EventSubscription

- Defined in modules/events.ts:196
Parameters
- listener: function
  - - (queryId: string, error: string): void
    - Parameters
      - queryId: string
      - error: string
      Returns void
- queryId: string
Returns EventSubscription