Node CrowdSec Client
    Preparing search index...

    Interface IScenario

    interface IScenario {
        announceToLAPI?: boolean;
        check?: (
            ip: AddressObject,
            req: IncomingMessage,
        ) => APITypes.Alert | APITypes.Alert[] | undefined;
        enrich?: (
            alert: APITypes.Alert,
            req: IncomingMessage,
        ) => APITypes.Alert | undefined;
        extractIp?: (req: IncomingMessage) => IIpExtractionResult | undefined;
        load?: () => Promise<void>;
        loaded?: boolean;
        name: string;
    }

    Implemented by

    Index
    announceToLAPI? check? enrich? extractIp? load? loaded? name
    announceToLAPI?: boolean

    announce current scenario to LAPI

    check?: (
        ip: AddressObject,
        req: IncomingMessage,
    ) => APITypes.Alert | APITypes.Alert[] | undefined
    enrich?: (
        alert: APITypes.Alert,
        req: IncomingMessage,
    ) => APITypes.Alert | undefined
    extractIp?: (req: IncomingMessage) => IIpExtractionResult | undefined

    allow some scenario to extract ip from the request

    load?: () => Promise<void>

    promise to load the scenario

    loaded?: boolean

    is the scenario loaded ?

    name: string

    name of the scenario

    Settings
    Member Visibility

    On This Page
    Properties