Class Firehose<Type, Data, CustomHeaders, CustomOptions>

constructor

• new Firehose<
      Type extends string = string,
      Data = any,
      CustomHeaders extends Record<string, any> = NoMoreHeaders,
      CustomOptions extends Record<string, any> = NoMoreOptions,
  >(
      name: string,
      options: FirehoseOptions<Type, Data, CustomHeaders, CustomOptions>,
  ): Firehose<Type, Data, CustomHeaders, CustomOptions>

• Create a new instance for a firehose

  Type Parameters

  • Type extends string = string
  • Data = any
  • CustomHeaders extends Record<string, any> = NoMoreHeaders
  • CustomOptions extends Record<string, any> = NoMoreOptions

  Parameters

  • name: string

    Firehose name
  • options: FirehoseOptions<Type, Data, CustomHeaders, CustomOptions>

    Firehose options

  Returns Firehose<Type, Data, CustomHeaders, CustomOptions>

ReadonlycomponentId

Readonlyname

checks

• get checks(): Checks<any>

• Return the status of the firehose in a standard format

  Returns Checks<any>

  check object as defined in the draft standard https://datatracker.ietf.org/doc/html/draft-inadarei-api-health-check-05

metrics

• get metrics(): Registry<"text/plain; version=0.0.4; charset=utf-8">

• Return the metrics registry

  Returns Registry<"text/plain; version=0.0.4; charset=utf-8">

status

• get status(): "pass" | "fail" | "warn"

• Overall component status

  Returns "pass" | "fail" | "warn"

close

• close(): Promise<void>

• Stop and close all the streams

  Returns Promise<void>

restart

• restart(): Promise<void>

• Perform the restart of the firehose

  Returns Promise<void>

start

• start(): Promise<void>

• Perform the piping of all the streams

  Returns Promise<void>

stop

• stop(): Promise<void>

• Stop the active sink and source and unpipe them from the engine

  Returns Promise<void>

addListener

• addListener(event: "done", listener: DoneEventHandler<Type>): this

• Register an event listener over the done event, which is emitted when a job has ended, either due to completion or failure.

  Parameters

  • event: "done"

    done event
  • listener: DoneEventHandler<Type>

    Done event listener

  Returns this

off

• off(event: "done", listener: DoneEventHandler<Type>): this

• Removes the specified listener from the listener array for the done event.

  Parameters

  • event: "done"

    done event
  • listener: DoneEventHandler<Type>

    The listener function to remove

  Returns this

on

• on(event: "error", listener: (error: Crash | Multi | Error) => void): this

• Add a listener for the error event, emitted when the component detects an error.

  Parameters

  • event: "error"

    error event
  • listener: (error: Crash | Multi | Error) => void

    Error event listener

  Returns this
• on(event: "status", listener: (status: "pass" | "fail" | "warn") => void): this

• Add a listener for the status event, emitted when the component status changes.

  Parameters

  • event: "status"

    status event
  • listener: (status: "pass" | "fail" | "warn") => void

    Status event listener

  Returns this
• on(
      event: "job",
      listener: JobEventHandler<Type, Data, CustomHeaders, CustomOptions>,
  ): this

• Register an event listener over the job event, which is emitted when a new job is received from a source.

  Parameters

  • event: "job"

    job event
  • listener: JobEventHandler<Type, Data, CustomHeaders, CustomOptions>

    Job event listener

  Returns this
• on(event: "done", listener: DoneEventHandler<Type>): this

• Register an event listener over the done event, which is emitted when a job has ended, either due to completion or failure.

  Parameters

  • event: "done"

    done event
  • listener: DoneEventHandler<Type>

    Done event listener

  Returns this
• on(event: "hold", listener: () => void): this

• Register an event listener over the hold event, which is emitted when the engine is paused due to inactivity.

  Parameters

  • event: "hold"

    restart event
  • listener: () => void

    Hold event listener

  Returns this

once

• once(event: "done", listener: DoneEventHandler<Type>): this

• Registers a one-time event listener over the done event, which is emitted when a job has ended, either due to completion or failure.

  Parameters

  • event: "done"

    done event
  • listener: DoneEventHandler<Type>

    Done event listener

  Returns this

prependListener

• prependListener(event: "done", listener: DoneEventHandler<Type>): this

• Registers a event listener over the done event, at the beginning of the listeners array, which is emitted when a job has ended, either due to completion or failure.

  Parameters

  • event: "done"

    done event
  • listener: DoneEventHandler<Type>

    Done event listener

  Returns this

prependOnceListener

• prependOnceListener(event: "done", listener: DoneEventHandler<Type>): this

• Registers a one-time event listener over the done event, at the beginning of the listeners array, which is emitted when a job has ended, either due to completion or failure.

  Parameters

  • event: "done"

    done event
  • listener: DoneEventHandler<Type>

    Done event listener

  Returns this

removeAllListeners

• removeAllListeners(event?: "done"): this

• Removes all listeners, or those of the specified event.

  Parameters

  • Optionalevent: "done"

    done event

  Returns this

removeListener

• removeListener(event: "done", listener: DoneEventHandler<Type>): this

• Removes the specified listener from the listener array for the done event.

  Parameters

  • event: "done"

    done event
  • listener: DoneEventHandler<Type>

    The listener function to remove

  Returns this