Type Alias ChangeStreamEvents<TSchema, TChange>

ChangeStreamEvents<TSchema, TChange>: {
    change(change: TChange): void;
    close(): void;
    end(): void;
    error(error: Error): void;
    init(response: any): void;
    more(response?: any): void;
    response(): void;
    resumeTokenChanged(token: unknown): void;
}

Type Parameters

Type declaration

  • change:function
    • Parameters

      Returns void

  • close:function
    • Returns void

      Note that the close event is currently emitted whenever the internal ChangeStreamCursor instance is closed, which can occur multiple times for a given ChangeStream instance.

      TODO(NODE-6434): address this issue in NODE-6434

  • end:function
    • Returns void

  • error:function
    • Parameters

      • error: Error

      Returns void

  • init:function
    • Parameters

      • response: any

      Returns void

  • more:function
    • Parameters

      • Optionalresponse: any

      Returns void

  • response:function
    • Returns void

  • resumeTokenChanged:function
    • Parameters

      • token: unknown

      Returns void