Class DecisionsBouncer

Hierarchy (view full)

BaseSubObject
- DecisionsBouncer

Index

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

`Private` `Optional` getStreamTimeout

getStreamTimeout?: Timeout

`Protected` http

http: AxiosInstance

`Private` runningStreams

runningStreams: DecisionsStream<any, string>[] = []

Methods

getRawStream

getRawStream(options?): Promise<APITypes.DecisionsStreamResponse>
Parameters
- Optional options: {
      origins?: string | string[];
      scenarios_containing?: string | string[];
      scenarios_not_containing?: string | string[];
      scopes?: string | string[];
      startup?: boolean;
  }
  - Optional origins?: string | string[]
  - Optional scenarios_containing?: string | string[]
  - Optional scenarios_not_containing?: string | string[]
  - Optional scopes?: string | string[]
  - Optional startup?: 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
- Optional optionsParam: {
      interval?: number;
      origins?: Origins | Origins[];
      scenarios_containing?: string | string[];
      scenarios_not_containing?: string | string[];
      scopes?: Scopes | Scopes[];
  }
  - Optional interval?: number
  - Optional origins?: Origins | Origins[]
  - Optional scenarios_containing?: string | string[]
  - Optional scenarios_not_containing?: string | string[]
  - Optional scopes?: Scopes | Scopes[]
- Optional cb: CallBack<Scopes, Origins>
Returns DecisionsStream<Scopes, Origins>
- Defined in packages/crowdsec-client/src/Decisions/DecisionsBouncer.ts:60

`Private` getStreamLoop

getStreamLoop<Scopes, Origins>(options, decisionStream, interval): Promise<void>
Type Parameters
- Scopes extends string = "ip"
- Origins extends string = string
Parameters
- options: APITypes.Decisions.GetDecisionsStream.RequestQuery
- decisionStream: DecisionsStream<Scopes, Origins>
- interval: number
Returns Promise<void>
- Defined in packages/crowdsec-client/src/Decisions/DecisionsBouncer.ts:138

`Private` getStreamLoopWrapper

getStreamLoopWrapper<Scopes, Origins>(options, decisionStream, interval): void
Type Parameters
- Scopes extends string = "ip"
- Origins extends string = string
Parameters
- options: APITypes.Decisions.GetDecisionsStream.RequestQuery
- decisionStream: DecisionsStream<Scopes, Origins>
- interval: number
Returns void
- Defined in packages/crowdsec-client/src/Decisions/DecisionsBouncer.ts:128

search

search(options?): Promise<APITypes.GetDecisionsResponse>
Parameters
- Optional options: 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

`Private` streamToCallback

streamToCallback<Scopes, Origins>(decisionStream, cb): void
Type Parameters
- Scopes extends string = "ip"
- Origins extends string = string
Parameters
- decisionStream: DecisionsStream<Scopes, Origins>
- cb: CallBack<Scopes, Origins>
Returns void
- Defined in packages/crowdsec-client/src/Decisions/DecisionsBouncer.ts:176

Class DecisionsBouncer

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DecisionsBouncer

Properties

Private Optional getStreamTimeout

Protected http

Private runningStreams

Methods

getRawStream

Parameters

Optional origins?: string | string[]

Optional scenarios_containing?: string | string[]

Optional scenarios_not_containing?: string | string[]

Optional scopes?: string | string[]

Optional startup?: boolean

Returns Promise<APITypes.DecisionsStreamResponse>

getStream

Type Parameters

Parameters

Optional interval?: number

Optional origins?: Origins | Origins[]

Optional scenarios_containing?: string | string[]

Optional scenarios_not_containing?: string | string[]

Optional scopes?: Scopes | Scopes[]

Returns DecisionsStream<Scopes, Origins>

Private getStreamLoop

Type Parameters

Parameters

Returns Promise<void>

Private getStreamLoopWrapper

Type Parameters

Parameters

Returns void

search

Parameters

Returns Promise<APITypes.GetDecisionsResponse>

stop

Returns void

Private streamToCallback

Type Parameters

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

`Private` `Optional` getStreamTimeout

`Protected` http

`Private` runningStreams

`Optional` origins?: string | string[]

`Optional` scenarios_containing?: string | string[]

`Optional` scenarios_not_containing?: string | string[]

`Optional` scopes?: string | string[]

`Optional` startup?: boolean

`Optional` interval?: number

`Optional` origins?: Origins | Origins[]

`Optional` scenarios_containing?: string | string[]

`Optional` scenarios_not_containing?: string | string[]

`Optional` scopes?: Scopes | Scopes[]

`Private` getStreamLoop

`Private` getStreamLoopWrapper

`Private` streamToCallback