Class SystemAPI

See

Not3Client.system

Hierarchy (View Summary)

SubClient
- SystemAPI

Index

Constructors

Properties

Methods

Constructors

constructor

new SystemAPI(api: AxiosInstance, options: ClientOptions): SystemAPI
Parameters
- api: AxiosInstance
- options: ClientOptions
Returns SystemAPI
Inherited from SubClient.constructor
- Defined in src/lib/SubClient.ts:11

Properties

`Protected` `Readonly`api

api: AxiosInstance

`Protected` `Readonly`options

options: ClientOptions

Methods

info

info(): Promise<InfoResponse>
Get system base information.

Returns Promise<InfoResponse>
The system information.

Throws
AxiosError If the request fails.
- Defined in src/clients/System.ts:17

stats

stats(password?: string): Promise<StatsResponse>
Get system statistics.
Parameters
- Optionalpassword: string
  The password for the stats, if required.
Returns Promise<StatsResponse>
The system statistics.

Throws
AxiosError If the request fails.
- Defined in src/clients/System.ts:30