@cucumber/cucumber
    Preparing search index...

    Type Alias CoordinatorContext<OptionsType>

    Context object passed to a plugin's coordinator function

    type CoordinatorContext<OptionsType> = {
        environment: CoordinatorEnvironment;
        logger: ILogger;
        on: <EventKey extends CoordinatorEventKey>(
            event: EventKey,
            handler: CoordinatorEventHandler<EventKey>,
        ) => void;
        operation: PluginOperation;
        options: OptionsType;
        transform: <EventKey extends CoordinatorTransformKey>(
            event: EventKey,
            handler: CoordinatorTransformer<EventKey>,
        ) => void;
    }

    Type Parameters

    • OptionsType
    Index

    Properties

    environment logger on operation options transform

    Properties

    environment: CoordinatorEnvironment

    Subset of the environment

    logger: ILogger

    Logger for emitting user-facing messages or diagnostics; goes to stderr

    on: <EventKey extends CoordinatorEventKey>(
        event: EventKey,
        handler: CoordinatorEventHandler<EventKey>,
    ) => void

    Register an event handler

    operation: PluginOperation

    The operation Cucumber is doing in this process

    options: OptionsType

    Options for the plugin

    If the plugin definition provides an optionsKey, this value will be from that key in the global options object. Otherwise, it will be the entire global options object.

    transform: <EventKey extends CoordinatorTransformKey>(
        event: EventKey,
        handler: CoordinatorTransformer<EventKey>,
    ) => void

    Register a transformer

    Settings

    Member Visibility

    On This Page

    Properties