Class Sequence

Firehose source (Readable) plug class

Hierarchy (View Summary)

Base<Plugs.Source.Sequence>
- Sequence

Index

Constructors

Properties

Accessors

checks componentId metrics name

Methods

_read start stop

Constructors

constructor

new Sequence(
plug: Plugs.Source.Sequence<string, any, AnyHeaders, AnyOptions>,
options?: SourceOptions,
): Sequence
Create a new instance for the firehose source
Parameters
- plug: Plugs.Source.Sequence<string, any, AnyHeaders, AnyOptions>
  Sequence source plug
- Optionaloptions: SourceOptions
  source options
Returns Sequence
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

Overrides 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

_read

_read(size: number): void
Perform the read of data from the source
Parameters
- size: number
Returns void
Overrides Base._read

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