Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StreamableRowPromise<T, TRow, TMeta>

Provides the ability to be used as both a promise, or an event emitter. Enabling an application to easily retrieve all results using async/await, while also enabling streaming of results by listening for the row and meta events.

Type parameters

  • T

  • TRow

  • TMeta

Hierarchy

  • StreamablePromise<T>
    • StreamableRowPromise

Index

Constructors

constructor

  • new StreamableRowPromise<T, TRow, TMeta>(fn: (rows: TRow[], meta: TMeta) => T): StreamableRowPromise<T, TRow, TMeta>
  • Type parameters

    • T

    • TRow

    • TMeta

    Parameters

    • fn: (rows: TRow[], meta: TMeta) => T
        • (rows: TRow[], meta: TMeta): T
        • Parameters

          • rows: TRow[]
          • meta: TMeta

          Returns T

    Returns StreamableRowPromise<T, TRow, TMeta>

Properties

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): StreamableRowPromise<T, TRow, TMeta>
  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns StreamableRowPromise<T, TRow, TMeta>

catch

  • catch<TResult>(onrejected?: null | ((reason: any) => TResult | PromiseLike<TResult>)): Promise<T | TResult>
  • Type parameters

    • TResult = never

    Parameters

    • Optional onrejected: null | ((reason: any) => TResult | PromiseLike<TResult>)

    Returns Promise<T | TResult>

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]
  • Returns (string | symbol)[]

finally

  • finally(onfinally?: null | (() => void)): Promise<T>
  • Parameters

    • Optional onfinally: null | (() => void)

    Returns Promise<T>

getMaxListeners

  • getMaxListeners(): number
  • Returns number

listenerCount

  • listenerCount(event: string | symbol): number
  • Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]
  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: (...args: any[]) => void): StreamableRowPromise<T, TRow, TMeta>
  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns StreamableRowPromise<T, TRow, TMeta>

on

  • on(event: string | symbol, listener: (...args: any[]) => void): StreamableRowPromise<T, TRow, TMeta>
  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns StreamableRowPromise<T, TRow, TMeta>

once

  • once(event: string | symbol, listener: (...args: any[]) => void): StreamableRowPromise<T, TRow, TMeta>
  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns StreamableRowPromise<T, TRow, TMeta>

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): StreamableRowPromise<T, TRow, TMeta>
  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns StreamableRowPromise<T, TRow, TMeta>

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): StreamableRowPromise<T, TRow, TMeta>
  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns StreamableRowPromise<T, TRow, TMeta>

rawListeners

  • rawListeners(event: string | symbol): Function[]
  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • Parameters

    • Optional event: string | symbol

    Returns StreamableRowPromise<T, TRow, TMeta>

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): StreamableRowPromise<T, TRow, TMeta>
  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns StreamableRowPromise<T, TRow, TMeta>

setMaxListeners

  • Parameters

    • n: number

    Returns StreamableRowPromise<T, TRow, TMeta>

then

  • then<TResult1, TResult2>(onfulfilled?: null | ((value: T) => TResult1 | PromiseLike<TResult1>), onrejected?: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)): Promise<TResult1 | TResult2>
  • Type parameters

    • TResult1 = T

    • TResult2 = never

    Parameters

    • Optional onfulfilled: null | ((value: T) => TResult1 | PromiseLike<TResult1>)
    • Optional onrejected: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)

    Returns Promise<TResult1 | TResult2>

Static getEventListener

  • getEventListener(emitter: DOMEventTarget | EventEmitter, name: string | symbol): Function[]
  • Returns a list listener for a specific emitter event name.

    Parameters

    • emitter: DOMEventTarget | EventEmitter
    • name: string | symbol

    Returns Function[]

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static on

  • on(emitter: EventEmitter, event: string, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>
  • Parameters

    • emitter: EventEmitter
    • event: string
    • Optional options: StaticEventEmitterOptions

    Returns AsyncIterableIterator<any>

Static once

  • once(emitter: NodeEventTarget, event: string | symbol, options?: StaticEventEmitterOptions): Promise<any[]>
  • once(emitter: DOMEventTarget, event: string, options?: StaticEventEmitterOptions): Promise<any[]>
  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

Generated using TypeDoc