Class ManagerSystem

Hierarchy

ApiConnection
- ManagerSystem

Constructors

constructor

new ManagerSystem(baseUrl: string): ManagerSystem
Parameters
- baseUrl: string
Returns ManagerSystem
Overrides ApiConnection.constructor
- Defined in manager/system.ts:16

Properties

`Protected` _jwt

_jwt: string = ''

`Protected` `Optional` _onAuthFailed

_onAuthFailed?: ((url: string) => void)

Type declaration

- (url: string): void
- Callback to run when a request returns status 401 (optional)
  Parameters
  - url: string
  Returns void

`Protected` `Optional` _requestFunc

_requestFunc?: RequestFunction

Custom request function (optional)

Accessors

jwt

set jwt(jwt: string): void
Parameters
- jwt: string
Returns void
Inherited from ApiConnection.jwt
- Defined in common/connection.ts:13

onAuthFailed

set onAuthFailed(callback: ((url: string) => void)): void
Parameters
- callback: ((url: string) => void)
  - - (url: string): void
    - Parameters
      
      url: string
      
      Returns void
Returns void
Inherited from ApiConnection.onAuthFailed
- Defined in common/connection.ts:29

requestFunc

set requestFunc(requestFunc: RequestFunction): void
Parameters
- requestFunc: RequestFunction
Returns void
Inherited from ApiConnection.requestFunc
- Defined in common/connection.ts:21

Methods

_request

_request<ResponseType>(url: string, method?: "GET" | "POST" | "PUT" | "DELETE", body?: unknown, auth?: boolean, blob?: boolean): Promise<ResponseType>
Type Parameters
- ResponseType = unknown
Parameters
- url: string
- method: "GET" | "POST" | "PUT" | "DELETE" = 'GET'
- body: unknown = {}
- auth: boolean = true
- blob: boolean = false
Returns Promise<ResponseType>
Inherited from ApiConnection._request
- Defined in common/connection.ts:33

backupStatus

backupStatus(): Promise<backupStatus>
Returns Promise<backupStatus>
- Defined in manager/system.ts:70

debug

debug(): Promise<debugStatus>
Returns Promise<debugStatus>
- Defined in manager/system.ts:78

debugResult

debugResult(): Promise<debugStatus>
Returns Promise<debugStatus>
- Defined in manager/system.ts:74

`Protected` delete

delete<ResponseType>(url: string, body?: unknown, auth?: boolean, blob?: boolean): Promise<ResponseType>
Type Parameters
- ResponseType = unknown
Parameters
- url: string
- body: unknown = {}
- auth: boolean = true
- blob: boolean = false
Returns Promise<ResponseType>
Inherited from ApiConnection.delete
- Defined in common/connection.ts:125

disk

disk(): Promise<"unknown" | "nvme">
Returns Promise<"unknown" | "nvme">
- Defined in manager/system.ts:106

`Protected` get

get<ResponseType>(url: string, auth?: boolean, blob?: boolean): Promise<ResponseType>
Type Parameters
- ResponseType = unknown
Parameters
- url: string
- auth: boolean = true
- blob: boolean = false
Returns Promise<ResponseType>
Inherited from ApiConnection.get
- Defined in common/connection.ts:99

getBitcoinP2PConnectionDetails

getBitcoinP2PConnectionDetails(): Promise<connectionDetails>
Returns Promise<connectionDetails>
- Defined in manager/system.ts:37

getBitcoinRPConnectionDetails

getBitcoinRPConnectionDetails(): Promise<RpcConnectionDetails>
Returns Promise<RpcConnectionDetails>
- Defined in manager/system.ts:41

getElectrumConnectionDetails

getElectrumConnectionDetails(): Promise<connectionDetails>
Returns Promise<connectionDetails>
- Defined in manager/system.ts:33

getHiddenServiceUrl

getHiddenServiceUrl(): Promise<string>
Returns Promise<string>
- Defined in manager/system.ts:29

getLndConnectUrls

getLndConnectUrls(): Promise<LndConnectionDetails>
Returns Promise<LndConnectionDetails>
- Defined in manager/system.ts:47

getUpdate

getUpdate(): Promise<false | versionFile>
Returns Promise<false | versionFile>
- Defined in manager/system.ts:51

getUpdateChannel

getUpdateChannel(): Promise<string>
Returns Promise<string>
- Defined in manager/system.ts:111

i2pCredentials

i2pCredentials(): Promise<{ password: string; username: string }>
Returns Promise<{ password: string; username: string }>
- Defined in manager/system.ts:127

info

info(): Promise<versionFile>
Get system information

Returns
Information about the software on the system

Returns Promise<versionFile>
- Defined in manager/system.ts:25

isCitadelOS

isCitadelOS(): Promise<boolean>
Returns Promise<boolean>
- Defined in manager/system.ts:121

memory

memory(): Promise<memUsage>
Returns Promise<memUsage>
- Defined in manager/system.ts:94

`Protected` post

post<ResponseType>(url: string, body?: unknown, auth?: boolean, blob?: boolean): Promise<ResponseType>
Type Parameters
- ResponseType = unknown
Parameters
- url: string
- body: unknown = {}
- auth: boolean = true
- blob: boolean = false
Returns Promise<ResponseType>
Inherited from ApiConnection.post
- Defined in common/connection.ts:107

`Protected` put

put<ResponseType>(url: string, body?: unknown, auth?: boolean, blob?: boolean): Promise<ResponseType>
Type Parameters
- ResponseType = unknown
Parameters
- url: string
- body: unknown = {}
- auth: boolean = true
- blob: boolean = false
Returns Promise<ResponseType>
Inherited from ApiConnection.put
- Defined in common/connection.ts:116

reboot

reboot(): Promise<systemStatus>
Returns Promise<systemStatus>
- Defined in manager/system.ts:86

setUpdateChannel

setUpdateChannel(channel: string): Promise<void>
Parameters
- channel: string
Returns Promise<void>
- Defined in manager/system.ts:115

shutdown

shutdown(): Promise<systemStatus>
Returns Promise<systemStatus>
- Defined in manager/system.ts:82

startQuickUpdate

startQuickUpdate(): Promise<void>
Returns Promise<void>
- Defined in manager/system.ts:62

startUpdate

startUpdate(): Promise<void>
Returns Promise<void>
- Defined in manager/system.ts:58

storage

storage(): Promise<memUsage>
Returns Promise<memUsage>
- Defined in manager/system.ts:90

temperature

temperature(): Promise<number>
Returns Promise<number>
- Defined in manager/system.ts:98

updateStatus

updateStatus(): Promise<updateStatus>
Returns Promise<updateStatus>
- Defined in manager/system.ts:66

uptime

uptime(): Promise<number>
Returns Promise<number>
- Defined in manager/system.ts:102

Generated using TypeDoc