Class DecisionsBouncer

Hierarchy (view full)

BaseSubObject
- DecisionsBouncer

Index

Constructors

Properties

Methods

getRawStream getStream search stop

Constructors

constructor

new DecisionsBouncer(options): 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?): Promise<APITypes.DecisionsStreamResponse>
Parameters
- Optionaloptions: {
      origins?: string | string[];
      scenarios_containing?: string | string[];
      scenarios_not_containing?: string | string[];
      scopes?: string | string[];
      startup?: boolean;
  }
  - Optionalorigins?: string | string[]
  - Optionalscenarios_containing?: string | string[]
  - Optionalscenarios_not_containing?: string | string[]
  - Optionalscopes?: string | string[]
  - Optionalstartup?: boolean
Returns Promise<APITypes.DecisionsStreamResponse>
- Defined in packages/crowdsec-client/src/Decisions/DecisionsBouncer.ts:27

getStream

getStream<Scopes, Origins>(optionsParam?, cb?): 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[];
  }
  - Optionalinterval?: number
  - Optionalorigins?: Origins | Origins[]
  - Optionalscenarios_containing?: string | string[]
  - Optionalscenarios_not_containing?: string | string[]
  - Optionalscopes?: Scopes | Scopes[]
- Optionalcb: CallBack<Scopes, Origins>
Returns DecisionsStream<Scopes, Origins>
- Defined in packages/crowdsec-client/src/Decisions/DecisionsBouncer.ts:60

search

search(options?): Promise<APITypes.GetDecisionsResponse>
Parameters
- Optionaloptions: Omit<APITypes.Decisions.GetDecisions.RequestQuery, commaSeparatedParams> & {
      origins?: string | string[];
      scenarios_containing?: string | string[];
      scenarios_not_containing?: string | string[];
  }
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