Class WatcherClient

Hierarchy (view full)

CrowdSecClient
- WatcherClient

Index

Constructors

Properties

#password? Alerts Decisions auth? autoRenewTimeout? debug heartbeat heartbeatTimeout? scenarios http

Accessors

Methods

_login _testConnection heartbeatLoop login registerWatcher setAuthenticationByTLS setAuthenticationHeaders stop testConnection getHTTPClient registerWatcher

Constructors

constructor

new WatcherClient(options): WatcherClient
Parameters
- options: IWatcherClientOptions
Returns WatcherClient
Overrides CrowdSecClient.constructor
- Defined in packages/crowdsec-client/src/Clients/WatcherClient.ts:25

Properties

`Private` `Optional` `Readonly` #password

#password?: string

Alerts

Alerts: Alerts

Decisions

Decisions: DecisionsWatcher

`Private` `Optional` `Readonly` auth

auth?: Omit<IWatcherAuthentication, "password">

`Private` `Optional` autoRenewTimeout

autoRenewTimeout?: Timeout

`Protected` debug

debug: Debugger = ...

`Private` `Readonly` heartbeat

heartbeat: number | boolean

`Private` `Optional` heartbeatTimeout

heartbeatTimeout?: Timeout

`Readonly` scenarios

scenarios: string[]

`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

`Private` _login

_login(): Promise<void>
Returns Promise<void>
- Defined in packages/crowdsec-client/src/Clients/WatcherClient.ts:49

`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

`Private` heartbeatLoop

heartbeatLoop(): Promise<void>
Returns Promise<void>
- Defined in packages/crowdsec-client/src/Clients/WatcherClient.ts:110

login

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

registerWatcher

registerWatcher(options): Promise<null>
Allow to register a watcher on CLAPI you need to validate on the local machine
Parameters
- options: APITypes.WatcherRegistrationRequest
Returns Promise<null>
- Defined in packages/crowdsec-client/src/Clients/WatcherClient.ts:137

`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/WatcherClient.ts:157

testConnection

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

`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

`Static` registerWatcher

registerWatcher(options): Promise<null>
Parameters
- options: APITypes.WatcherRegistrationRequest & IHTTPOptions
Returns Promise<null>
- Defined in packages/crowdsec-client/src/Clients/WatcherClient.ts:141

Generated using TypeDoc