Class Base<T>Abstract

constructor

• new Base<T extends Plugs.Source.Any<string, any, NoMoreHeaders, NoMoreOptions>>(
      plug: T,
      options?: SourceOptions,
  ): Base<T>

• Create a new instance for the firehose source

  Type Parameters

  • T extends Plugs.Source.Any<string, any, NoMoreHeaders, NoMoreOptions>

  Parameters

  • plug: T

    source plug instance
  • Optionaloptions: SourceOptions

    source options

  Returns Base<T>

ReadonlyplugWrapper

checks

• get checks(): Checks<any>

• Return the status of the stream 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

componentId

• get componentId(): string

• Component identification

  Returns string

metrics

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

• Metrics registry for this component

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

name

• get name(): string

• Component name

  Returns string

Abstract_read

• _read(size: number): void

• Perform the read of data from the source

  Parameters

  • size: number

  Returns void

start

• start(): Promise<void>

• Start the Plug and the underlayer resources, making it available

  Returns Promise<void>

stop

• stop(): Promise<void>

• Stop the Plug and the underlayer resources, making it unavailable

  Returns Promise<void>