Node CrowdSec Client
    Preparing search index...

    Class DecisionsBouncer

    Hierarchy (View Summary)

    Index
    constructor
    http
    getRawStream getStream search stop
    http: AxiosInstance

    • Parameters

      • Optionaloptions: {
            origins?: string | string[];
            scenarios_containing?: string | string[];
            scenarios_not_containing?: string | string[];
            scopes?: string | string[];
            startup?: boolean;
        }

      Returns Promise<APITypes.DecisionsStreamResponse>

    • Type Parameters

      • Scopes extends string = "ip"
      • Origins extends string = string

      Parameters

      • OptionaloptionsParam: {
            interval?: number;
            origins?: Origins | Origins[];
            scenarios_containing?: string | string[];
            scenarios_not_containing?: string | string[];
            scopes?: Scopes | Scopes[];
        }
      • Optionalcb: CallBack<Scopes, Origins>

      Returns DecisionsStream<Scopes, Origins>

    • Parameters

      • Optionaloptions: Omit<APITypes.Decisions.GetDecisions.RequestQuery, commaSeparatedParams> & {
            origins?: string | string[];
            scenarios_containing?: string | string[];
            scenarios_not_containing?: string | string[];
        }
        • Optionalorigins?: string | string[]

          name of origins. If provided, then only the decisions originating from provided origins would be returned.

        • Optionalscenarios_containing?: string | string[]

          If provided, only the decisions created by scenarios containing any of the provided word would be returned.

        • Optionalscenarios_not_containing?: string | string[]

          If provided, only the decisions created by scenarios, not containing any of the provided word would be returned.

      Returns Promise<APITypes.GetDecisionsResponse>

    • stop running streams

      Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods