Class BouncerClient

Hierarchy (view full)

CrowdSecClient
- BouncerClient

Index

Constructors

Properties

#auth? Decisions debug http

Accessors

Methods

_testConnection login setAuthenticationByTLS setAuthenticationHeaders stop testConnection getHTTPClient

Constructors

constructor

new BouncerClient(options): BouncerClient
Parameters
- options: IBouncerClientOptions
Returns BouncerClient
Overrides CrowdSecClient.constructor
- Defined in packages/crowdsec-client/src/Clients/BouncerClient.ts:14

Properties

`Private` `Optional` #auth

#auth?: IBouncerAuthentication

Decisions

Decisions: DecisionsBouncer

`Protected` debug

debug: Debugger = ...

`Protected` `Static` http

http: AxiosInstance

Accessors

http

get http(): AxiosInstance
Returns AxiosInstance
Inherited from CrowdSecClient.http
- Defined in packages/crowdsec-client/src/Clients/CrowdSecClient.ts:22

Methods

`Protected` _testConnection

_testConnection(url): Promise<void>
Parameters
- url: string
Returns Promise<void>
Inherited from CrowdSecClient._testConnection
- Defined in packages/crowdsec-client/src/Clients/CrowdSecClient.ts:151

login

login(): Promise<void>
Returns Promise<void>
Overrides CrowdSecClient.login
- Defined in packages/crowdsec-client/src/Clients/BouncerClient.ts:33

`Protected` setAuthenticationByTLS

setAuthenticationByTLS(auth): void
Parameters
- auth: ITLSAuthentication
Returns void
Inherited from CrowdSecClient.setAuthenticationByTLS
- Defined in packages/crowdsec-client/src/Clients/CrowdSecClient.ts:61

`Protected` setAuthenticationHeaders

setAuthenticationHeaders(headers): void
Parameters
- headers: Record<string, string>
Returns void
Inherited from CrowdSecClient.setAuthenticationHeaders
- Defined in packages/crowdsec-client/src/Clients/CrowdSecClient.ts:138

stop

stop(): Promise<void>
stop the current client, and running processes

Returns Promise<void>
Overrides CrowdSecClient.stop
- Defined in packages/crowdsec-client/src/Clients/BouncerClient.ts:41

testConnection

testConnection(): Promise<void>
Returns Promise<void>
Overrides CrowdSecClient.testConnection
- Defined in packages/crowdsec-client/src/Clients/BouncerClient.ts:37

`Protected` `Static` getHTTPClient

getHTTPClient(options): AxiosInstance
Parameters
- options: IHTTPOptions
Returns AxiosInstance
Inherited from CrowdSecClient.getHTTPClient
- Defined in packages/crowdsec-client/src/Clients/CrowdSecClient.ts:35

Generated using TypeDoc