Class Tap

Firehose sink (Writable) plug class

Hierarchy (View Summary)

Base<Plugs.Sink.Tap>
- Tap

Index

Constructors

Properties

Accessors

checks componentId metrics name

Methods

_write start stop

Constructors

constructor

new Tap(
plug: Plugs.Sink.Tap<string, any, AnyHeaders, AnyOptions>,
options?: SinkOptions,
): Tap
Create a new Tap instance
Parameters
- plug: Plugs.Sink.Tap<string, any, AnyHeaders, AnyOptions>
  Tap sink plug
- Optionaloptions: SinkOptions
  sink options
Returns Tap
Overrides Base.constructor

Properties

`Readonly`plugWrapper

plugWrapper: PlugWrapper

Wrapped source plug

Accessors

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

Inherited from Base.checks

componentId

get componentId(): string
Component identification

Returns string
Inherited from Base.componentId

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">
Inherited from Base.metrics

name

get name(): string
Component name

Returns string
Inherited from Base.name

Methods

_write

_write(
    data: OpenJobHandler,
    encoding: string,
    callback: (error?: Crash | Error) => void,
): void
Perform the publication of the information on the sink destination
Parameters
- data: OpenJobHandler
- encoding: string
- callback: (error?: Crash | Error) => void
Returns void
Overrides Base._write

start

start(): Promise<void>
Start the Plug and the underlayer resources, making it available

Returns Promise<void>
Inherited from Base.start

stop

stop(): Promise<void>
Stop the Plug and the underlayer resources, making it unavailable

Returns Promise<void>
Inherited from Base.stop