Class NUTClient

Hierarchy

TypedEmitter<NUTClientEvents>
- NUTClient

Constructors

constructor

new NUTClient(
 host: string,
 port?: number,
 options?: INUTClientOptions,
): NUTClient
Parameters
- host: string
- port: number = 3493
- Optionaloptions: INUTClientOptions
Returns NUTClient
Overrides TypedEmitter<NUTClientEvents>.constructor
- Defined in src/NUTClient.ts:76

Properties

`Static`defaultMaxListeners

defaultMaxListeners: number

Accessors

connected

get connected(): boolean
Check if the client is currently connected to the NUT server.

Returns boolean
true if connected, false otherwise
- Defined in src/NUTClient.ts:100

Methods

addListener

addListener(
event: U,
listener: NUTClientEvents[U],
): this
Type Parameters
- U extends keyof NUTClientEvents
Parameters
- event: U
- listener: NUTClientEvents[U]
Returns this
Inherited from TypedEmitter.addListener
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:11

connect

connect(username: string, password: string): Promise<void>
Allow to authenticate user on the UPS
Parameters
- username: string
 {string}
- password: string
 {string}
Returns Promise<void>
- Defined in src/NUTClient.ts:287

destroy

destroy(): void
Destroy the client and release all resources. After calling destroy(), the client cannot be reused.

Returns void
- Defined in src/NUTClient.ts:640

emit

emit(
event: U,
...args: Parameters<NUTClientEvents[U]>,
): boolean
Type Parameters
- U extends keyof NUTClientEvents
Parameters
- event: U
- ...args: Parameters<NUTClientEvents[U]>
Returns boolean
Inherited from TypedEmitter.emit
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:19

eventNames

eventNames(): U[]
Type Parameters
- U extends keyof NUTClientEvents
Returns U[]
Inherited from TypedEmitter.eventNames
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:20

forceShutdown

forceShutdown(ups: string): Promise<string>
Force a shutdown on the UPS (set the FSD flag).
Parameters
- ups: string
 The name of the UPS
Returns Promise<string>
The server response

Remarks
Requires master or FSD permission. Use with caution.
- Defined in src/NUTClient.ts:560

getCommandDescription

getCommandDescription(ups: string, command: string): Promise<string>
get the description of a command
Parameters
- ups: string
- command: string
Returns Promise<string>
- Defined in src/NUTClient.ts:405

getMaster

getMaster(ups: string): Promise<boolean>
Check if this client is master for the UPS
Parameters
- ups: string
Returns Promise<boolean>
- Defined in src/NUTClient.ts:541

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from TypedEmitter.getMaxListeners
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:24

getNumLogins

getNumLogins(ups: string): Promise<number>
get number of clients logged (using LOGIN command)
Parameters
- ups: string
Returns Promise<number>
- Defined in src/NUTClient.ts:526

getTracking

getTracking(uuid: string): Promise<string>
Get the status of a previously tracked write command by its UUID.
Parameters
- uuid: string
 The tracking UUID returned by a write command
Returns Promise<string>
'PENDING', 'SUCCESS', or 'ERR'

Remarks
Requires NUT 2.8.0+ (protocol v1.3) on the server.
- Defined in src/NUTClient.ts:585

getUPS

getUPS(name: string): Promise<UPS | undefined>
allow to select an UPS, and get an UPS object
Parameters
- name: string
 {string} name of the ups to search
Returns Promise<UPS | undefined>
- Defined in src/NUTClient.ts:349

getUPSDescription

getUPSDescription(ups: string): Promise<string>
Get the description of a UPS (from ups.conf desc= field).
Parameters
- ups: string
 The name of the UPS
Returns Promise<string>
The UPS description string
- Defined in src/NUTClient.ts:550

getVariable

getVariable(ups: string, variable: nutVariablesNames): Promise<string>
allow to get a variable
Parameters
- ups: string
- variable: nutVariablesNames
Returns Promise<string>
- Defined in src/NUTClient.ts:475

getVariableDescription

getVariableDescription(
ups: string,
variable: nutVariablesNames,
): Promise<string>
get the description of a variable
Parameters
- ups: string
- variable: nutVariablesNames
Returns Promise<string>
- Defined in src/NUTClient.ts:387

getVariableEnum

getVariableEnum(ups: string, variable: nutVariablesNames): Promise<string[]>
get the enum variables
Parameters
- ups: string
- variable: nutVariablesNames
Returns Promise<string[]>
- Defined in src/NUTClient.ts:433

getVariableRange

getVariableRange(ups: string, variable: nutVariablesNames): Promise<string[]>
get the range of the variable
Parameters
- ups: string
- variable: nutVariablesNames
Returns Promise<string[]>
- Defined in src/NUTClient.ts:442

getVariableType

getVariableType(
 ups: string,
 variable: nutVariablesNames,
): Promise<
 { type: "RW"
 | "ENUM"
 | "STRING"
 | "RANGE"
 | "NUMBER" } & Record<string, unknown>,
>
get the type of variable ... Defined by the NUT driver, default to NUMBER
Parameters
- ups: string
- variable: nutVariablesNames
Returns Promise<
 { type: "RW"
 | "ENUM"
 | "STRING"
 | "RANGE"
 | "NUMBER" } & Record<string, unknown>,
>
- Defined in src/NUTClient.ts:396

help

help(): Promise<string>
get help

Returns Promise<string>
- Defined in src/NUTClient.ts:328

listClients

listClients(ups: string): Promise<string[]>
List the logged clients on the UPS
Parameters
- ups: string
Returns Promise<string[]>
- Defined in src/NUTClient.ts:483

listCommands

listCommands(ups: string): Promise<string[]>
list the available commands on the UPS
Parameters
- ups: string
Returns Promise<string[]>
- Defined in src/NUTClient.ts:378

listenerCount

listenerCount(type: keyof NUTClientEvents): number
Parameters
- type: keyof NUTClientEvents
Returns number
Inherited from TypedEmitter.listenerCount
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:21

listeners

listeners(type: U): NUTClientEvents[U][]
Type Parameters
- U extends keyof NUTClientEvents
Parameters
- type: U
Returns NUTClientEvents[U][]
Inherited from TypedEmitter.listeners
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:22

listUPS

listUPS(): Promise<UPS[]>
List all available UPS devices.

Returns Promise<UPS[]>
Array of UPS objects with parsed name and description.
- Defined in src/NUTClient.ts:335

listVariables

listVariables(ups: string): Promise<Partial<Record<nutVariablesNames, string>>>
List all the variables of the UPS
Parameters
- ups: string
 {string}
Returns Promise<Partial<Record<nutVariablesNames, string>>>
- Defined in src/NUTClient.ts:358

listWriteableVariables

listWriteableVariables(ups: string): Promise<Record<string, string>>
List writeable variables for a UPS.
Parameters
- ups: string
Returns Promise<Record<string, string>>
Object mapping variable names to their current values

Remarks
Unlike RawNUTClient which returns raw strings, this method parses the response into a key-value object
- Defined in src/NUTClient.ts:492

login(ups: string): Promise<string>
Parameters
- ups: string
 {string} the name of the UPS
Returns Promise<string>

Remarks
You probably shouldn't send this command unless you are upsmon, or a upsmon replacement.
- Defined in src/NUTClient.ts:511

logout

logout(): Promise<string>
will log out from the server

Returns Promise<string>
- Defined in src/NUTClient.ts:296

master

master(ups: string): Promise<string>
Set this client as master for the UPS
Parameters
- ups: string
Returns Promise<string>

Remarks
You probably shouldn't send this command unless you are upsmon, or a upsmon replacement.
- Defined in src/NUTClient.ts:533

netVersion

netVersion(): Promise<string>
get network protocol version

Returns Promise<string>
- Defined in src/NUTClient.ts:322

off

off(
event: U,
listener: NUTClientEvents[U],
): this
Type Parameters
- U extends keyof NUTClientEvents
Parameters
- event: U
- listener: NUTClientEvents[U]
Returns this
Inherited from TypedEmitter.off
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:18

on

on(
event: U,
listener: NUTClientEvents[U],
): this
Type Parameters
- U extends keyof NUTClientEvents
Parameters
- event: U
- listener: NUTClientEvents[U]
Returns this
Inherited from TypedEmitter.on
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:17

once

once(
event: U,
listener: NUTClientEvents[U],
): this
Type Parameters
- U extends keyof NUTClientEvents
Parameters
- event: U
- listener: NUTClientEvents[U]
Returns this
Inherited from TypedEmitter.once
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:16

prependListener

prependListener(
event: U,
listener: NUTClientEvents[U],
): this
Type Parameters
- U extends keyof NUTClientEvents
Parameters
- event: U
- listener: NUTClientEvents[U]
Returns this
Inherited from TypedEmitter.prependListener
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:12

prependOnceListener

prependOnceListener(
event: U,
listener: NUTClientEvents[U],
): this
Type Parameters
- U extends keyof NUTClientEvents
Parameters
- event: U
- listener: NUTClientEvents[U]
Returns this
Inherited from TypedEmitter.prependOnceListener
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:13

rawListeners

rawListeners(type: U): NUTClientEvents[U][]
Type Parameters
- U extends keyof NUTClientEvents
Parameters
- type: U
Returns NUTClientEvents[U][]
Inherited from TypedEmitter.rawListeners
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:23

removeAllListeners

removeAllListeners(event?: keyof NUTClientEvents): this
Parameters
- Optionalevent: keyof NUTClientEvents
Returns this
Inherited from TypedEmitter.removeAllListeners
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:15

removeListener

removeListener(
event: U,
listener: NUTClientEvents[U],
): this
Type Parameters
- U extends keyof NUTClientEvents
Parameters
- event: U
- listener: NUTClientEvents[U]
Returns this
Inherited from TypedEmitter.removeListener
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:14

runCommand

runCommand(
 ups: string,
 command: string,
 param?: string,
 options?: TrackingOptions,
): Promise<CommandResult | TrackedResult>
run a command on the UPS
Parameters
- ups: string
- command: string
- Optionalparam: string
 Optional command parameter (e.g., delay in seconds)
- Optionaloptions: TrackingOptions
 Optional tracking options (followTracking, trackingTimeout, trackingPollInterval)
Returns Promise<CommandResult | TrackedResult>
- Defined in src/NUTClient.ts:416

send

send(cmd: string[], timeout?: number): Promise<string>
allow to send custom command
Parameters
- cmd: string[]
 {string[]} the command to send
- Optionaltimeout: number
 {number} timeout for this command
Returns Promise<string>
- Defined in src/NUTClient.ts:278

setMaxListeners

setMaxListeners(n: number): this
Parameters
- n: number
Returns this
Inherited from TypedEmitter.setMaxListeners
- Defined in node_modules/.pnpm/tiny-typed-emitter@2.1.0/node_modules/tiny-typed-emitter/lib/index.d.ts:25

setTracking

setTracking(enabled: boolean): Promise<string>
Enable or disable command tracking for idempotent write operations.

When tracking is enabled, write commands (SET VAR, INSTCMD) return OK TRACKING <uuid> instead of OK. The UUID can be polled via getTracking to check the command outcome.
Parameters
- enabled: boolean
 true to enable tracking, false to disable
Returns Promise<string>

Remarks
Requires NUT 2.8.0+ (protocol v1.3) on the server.
- Defined in src/NUTClient.ts:574

setVariable

setVariable(
 ups: string,
 variable: nutVariablesNames,
 value: unknown,
 options?: TrackingOptions,
): Promise<CommandResult | TrackedResult>
allow to set a variable
Parameters
- ups: string
- variable: nutVariablesNames
- value: unknown
- Optionaloptions: TrackingOptions
 Optional tracking options (followTracking, trackingTimeout, trackingPollInterval)
Returns Promise<CommandResult | TrackedResult>
- Defined in src/NUTClient.ts:453

startTLS

startTLS(
tlsOptions?: Omit<ConnectionOptions, "socket" | "host" | "port">,
): Promise<void>
allow to upgrade the connection with TLS
Parameters
- OptionaltlsOptions: Omit<ConnectionOptions, "socket" | "host" | "port">
Returns Promise<void>

See
to check the arguments allowed
- Defined in src/NUTClient.ts:306

version

version(): Promise<string>
get server version

Returns Promise<string>
- Defined in src/NUTClient.ts:315

`Static`create

create(
 host: string,
 port?: number,
 options?: INUTClientOptions,
): Promise<NUTClient>
Static factory method that creates a NUTClient and optionally authenticates when credentials are provided in options. Credentials are cleared from stored options after successful authentication to reduce the risk of credential leaks.
Parameters
- host: string
 hostname or IP address
- Optionalport: number
 port number (default 3493)
- Optionaloptions: INUTClientOptions
 client options including optional credentials
Returns Promise<NUTClient>
- Defined in src/NUTClient.ts:113

Class NUTClient

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns NUTClient

Properties

StaticdefaultMaxListeners

Accessors

connected

Returns boolean

Methods

addListener

Type Parameters

Parameters

Returns this

connect

Parameters

Returns Promise<void>

destroy

Returns void

emit

Type Parameters

Parameters

Returns boolean

eventNames

Type Parameters

Returns U[]

forceShutdown

Parameters

Returns Promise<string>

Remarks

getCommandDescription

Parameters

Returns Promise<string>

getMaster

Parameters

Returns Promise<boolean>

getMaxListeners

Returns number

getNumLogins

Parameters

Returns Promise<number>

getTracking

Parameters

Returns Promise<string>

Remarks

getUPS

Parameters

Returns Promise<UPS | undefined>

getUPSDescription

Parameters

Returns Promise<string>

getVariable

Parameters

Returns Promise<string>

getVariableDescription

Parameters

Returns Promise<string>

getVariableEnum

Parameters

Returns Promise<string[]>

getVariableRange

Parameters

Returns Promise<string[]>

getVariableType

Parameters

Returns Promise< { type: "RW" | "ENUM" | "STRING" | "RANGE" | "NUMBER" } & Record<string, unknown>,>

help

Returns Promise<string>

listClients

Parameters

Returns Promise<string[]>

listCommands

Parameters

`Static`defaultMaxListeners

Returns Promise<
{ type: "RW"
| "ENUM"
| "STRING"
| "RANGE"
| "NUMBER" } & Record<string, unknown>,
>