Class Engine

constructor

• new Engine(name: string, options?: EngineOptions): Engine

• Create a new instance of the datapoint filter stream

  Parameters

  • name: string

    name of the transform
  • Optionaloptions: EngineOptions

    engine options

  Returns Engine

ReadonlycomponentId

Readonlyname

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

_transform

• _transform(
      job: OpenJobHandler,
      encoding: string,
      callback: (error?: Crash, chunk?: any) => void,
  ): void

• Perform the filter strategy depending of the job type

  Parameters

  • job: OpenJobHandler

    publication job object
  • encoding: string

    encoding of the job
  • callback: (error?: Crash, chunk?: any) => void

    callback to return the job

  Returns void

close

• close(): void

• Close the stream and release resources

  Returns void

on

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

• Emitted when it is appropriate to resume writing data to the stream

  Parameters

  • event: "drain"
  • listener: () => void

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

• Emitted when stream.resume() is called and readableFlowing is not true

  Parameters

  • event: "resume"
  • listener: () => void

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

• Emitted when there is data available to be read from the stream

  Parameters

  • event: "readable"
  • listener: () => void

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

• Emitted when stream.pause() is called and readableFlowing is not false

  Parameters

  • event: "pause"
  • listener: () => void

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

• Due to the implementation of consumer classes, this event will never emitted

  Parameters

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

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

• Emitted when there is no more data to be consumed from the stream

  Parameters

  • event: "end"
  • listener: () => void

  Returns this
• on(event: "data", listener: (chunk: any) => void): this

• Emitted whenever the stream is relinquishing ownership of a chunk of data to a consumer

  Parameters

  • event: "data"
  • listener: (chunk: any) => void

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

• Emitted when the stream have been closed

  Parameters

  • event: "close"
  • listener: () => void

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

• Emitted on every state change

  Parameters

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

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

• Emitted when the stream is finished

  Parameters

  • event: "finish"
  • listener: () => void

  Returns this
• on(event: "pipe", listener: (source: Readable) => void): this

• Emitted when the stream is piped with a readable stream

  Parameters

  • event: "pipe"
  • listener: (source: Readable) => void

  Returns this
• on(event: "unpipe", listener: (source: Readable) => void): this

• Emitted when the stream is piped with a readable stream

  Parameters

  • event: "unpipe"
  • listener: (source: Readable) => void

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

• Emitted when the inactivity time exceeds the limit

  Parameters

  • event: "hold"
  • listener: () => void

  Returns this

start

• start(): void

• Start the stream

  Returns void

stop

• stop(): void

• Stop the stream

  Returns void