Interface IScenario

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

Implemented by

Properties

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

Properties

OptionalannounceToLAPI

announceToLAPI?: boolean

announce current scenario to LAPI

Optionalcheck

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

Optionalenrich

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

OptionalextractIp

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

allow some scenario to extract ip from the request

Optionalload

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

promise to load the scenario

Optionalloaded

loaded?: boolean

is the scenario loaded ?

name

name: string

name of the scenario

Settings

Member Visibility

On This Page

Properties