Type Alias FormatterPlugin<OptionsType>

A plugin that consumes Cucumber Messages and writes formatted output to a stream

type FormatterPlugin<OptionsType = any> = {
    formatter: (
        context: FormatterPluginContext<OptionsType>,
    ) => PromiseLike<PluginCleanup | void> | PluginCleanup | void;
    optionsKey?: string;
    type: "formatter";
}

Type Parameters

OptionsType = any

Index

Properties

formatter optionsKey? type

Properties

formatter

formatter: (
context: FormatterPluginContext<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 before the stream is finished.

`Optional`optionsKey

optionsKey?: string

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

type

type: "formatter"