Class Pipeline

constructor

• new Pipeline(
      serenity: Serenity,
      properties?: Partial<PipelineProperties>,
  ): Pipeline

  Creates a new instance of the Pipeline class.

  Parameters

  • serenity: Serenity

    The serenity server instance.
  • Optionalproperties: Partial<PipelineProperties>

    The properties for the pipeline.

  Returns Pipeline

Readonlyesm

Readonlylogger

Readonlyplugins

path

• get path(): string

  The path to the plugins directory.

  Returns string
• set path(_: string): void

  The path to the plugins directory.

  Parameters

  • _: string

  Returns void

bundle

• bundle(plugin: Plugin): void

  Parameters

  • plugin: Plugin

  Returns void

initialize

• initialize(): void

  Initializes the plugins pipeline.

  Returns void

linkModule

• linkModule(name: string, module: unknown): void

  Link a module to the pipeline.

  Parameters

  • name: string

    The name of the module to link.
  • module: unknown

    The module to link.

  Returns void

loadFromTextSource

• loadFromTextSource(
      path: string,
      source: string,
      isBundled?: boolean,
  ): null | Plugin<unknown>

  Load a plugin from a text source.

  Parameters

  • path: string
  • source: string

    The source code of the plugin.
  • isBundled: boolean = false

    Whether the plugin is bundled or not.

  Returns null | Plugin<unknown>

reload

• reload(plugin: Plugin): void

  Parameters

  • plugin: Plugin

  Returns void

start

• start(): void

  Starts the plugins pipeline.

  Returns void

stop

• stop(): void

  Stops the plugins pipeline.

  Returns void