Class DecisionsBouncer

Hierarchy (View Summary)

BaseSubObject
- DecisionsBouncer

Index

Constructors

Properties

Methods

getRawStream getStream search stop

Constructors

constructor

new DecisionsBouncer(options: IBaseSubObjectOptions): DecisionsBouncer
Parameters
- options: IBaseSubObjectOptions
Returns DecisionsBouncer
Inherited from BaseSubObject.constructor
- Defined in packages/crowdsec-client/src/BaseSubObject.ts:9

Properties

`Protected`http

http: AxiosInstance

Methods

getRawStream

getRawStream(
    options?: {
        origins?: string | string[];
        scenarios_containing?: string | string[];
        scenarios_not_containing?: string | string[];
        scopes?: string | string[];
        startup?: boolean;
    },
): Promise<APITypes.DecisionsStreamResponse>
Parameters
- Optionaloptions: {
      origins?: string | string[];
      scenarios_containing?: string | string[];
      scenarios_not_containing?: string | string[];
      scopes?: string | string[];
      startup?: boolean;
  }
Returns Promise<APITypes.DecisionsStreamResponse>
- Defined in packages/crowdsec-client/src/Decisions/DecisionsBouncer.ts:27

getStream

getStream<Scopes extends string = "ip", Origins extends string = string>(
    optionsParam?: {
        interval?: number;
        origins?: Origins | Origins[];
        scenarios_containing?: string | string[];
        scenarios_not_containing?: string | string[];
        scopes?: Scopes | Scopes[];
    },
    cb?: CallBack<Scopes, Origins>,
): DecisionsStream<Scopes, Origins>
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>
- Defined in packages/crowdsec-client/src/Decisions/DecisionsBouncer.ts:60

search

search(
    options?: Omit<
        APITypes.Decisions.GetDecisions.RequestQuery,
        commaSeparatedParams,
    > & {
        origins?: string
        | string[];
        scenarios_containing?: string | string[];
        scenarios_not_containing?: string | string[];
    },
): Promise<APITypes.GetDecisionsResponse>
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>
- Defined in packages/crowdsec-client/src/Decisions/DecisionsBouncer.ts:206

stop

stop(): void
stop running streams

Returns void
- Defined in packages/crowdsec-client/src/Decisions/DecisionsBouncer.ts:202