Interface IScenario

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

Implemented by

Properties

announceToLAPI? check? enrich? extractIp? load? loaded? name

Properties

Optional announceToLAPI

announceToLAPI?: boolean

announce current scenario to LAPI

Optional check

check?: ((ip, req) => undefined | APITypes.Alert | APITypes.Alert[])

Type declaration

Optional enrich

enrich?: ((alert, req) => undefined | APITypes.Alert)

Type declaration

Optional extractIp

extractIp?: ((req) => undefined | IIpExtractionResult)

allow some scenario to extract ip from the request

Type declaration

Param: req

Optional load

load?: (() => Promise<void>)

promise to load the scenario

Type declaration

    • (): Promise<void>

    • promise to load the scenario

      Returns Promise<void>

Optional loaded

loaded?: boolean

is the scenario loaded ?

name

name: string

name of the scenario

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc