Type Alias Plugin<OptionsType>

A plugin that can subscribe to events and register transforms

type Plugin<OptionsType = any> = {
    coordinator: (
        context: CoordinatorContext<OptionsType>,
    ) => PromiseLike<PluginCleanup | void> | PluginCleanup | void;
    optionsKey?: string;
    type: "plugin";
}

Type Parameters

OptionsType = any

Index

Properties

coordinator optionsKey? type

Properties

coordinator

coordinator: (
context: CoordinatorContext<OptionsType>,
) => PromiseLike<PluginCleanup | void> | PluginCleanup | void

Coordinator function called during initialization

Remarks

Can do async work, and the Promise will be awaited. Can optionally return a cleanup function to be called when Cucumber is about to exit.

`Optional`optionsKey

optionsKey?: string

Optional key to extract plugin-specific options from the root options object

type

type: "plugin"