Class Monitor

Allow to monitor events on the UPS

Example

const client = new NUTClient('127.0.0.1', 3493);
const monitor = new Monitor(client, 'myUps');
monitor.on('ONBATT', () => {
  console.log('UPS "myUps" lost power and is now on battery');
});
await monitor.start()

Hierarchy

TypedEmitter<IMonitorEvents>
- Monitor

Index

Constructors

constructor

Properties

defaultMaxListeners

Constructors

constructor

new Monitor(
 client: NUTClient,
 upsName: string,
 options?: IMonitorOptions,
): Monitor
Parameters
- client: NUTClient
- upsName: string
- options: IMonitorOptions = {}
Returns Monitor
Overrides TypedEmitter<IMonitorEvents>.constructor
- Defined in src/Monitor.ts:175

Properties

`Static`defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

addListener(
event: U,
listener: IMonitorEvents[U],
): this
Type Parameters
- U extends keyof IMonitorEvents
Parameters
- event: U
- listener: IMonitorEvents[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

destroy

destroy(): void
Destroy the monitor and release all resources. After calling destroy(), the monitor cannot be reused.
- Stops the heartbeat
- Removes all event listeners
- Cleans up internal state
Safe to call multiple times (idempotent).
Returns void
- Defined in src/Monitor.ts:230

emit

emit(
event: U,
...args: Parameters<IMonitorEvents[U]>,
): boolean
Type Parameters
- U extends keyof IMonitorEvents
Parameters
- event: U
- ...args: Parameters<IMonitorEvents[U]>
Returns boolean
Overrides TypedEmitter.emit
- Defined in src/Monitor.ts:425

eventNames

eventNames(): U[]
Type Parameters
- U extends keyof IMonitorEvents
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

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

isDestroyed

isDestroyed(): boolean
Check if the monitor has been destroyed.

Returns boolean
- Defined in src/Monitor.ts:250

isPaused

isPaused(): boolean
Check if monitoring is currently paused.

Returns boolean
- Defined in src/Monitor.ts:278

listenerCount

listenerCount(type: keyof IMonitorEvents): number
Parameters
- type: keyof IMonitorEvents
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): IMonitorEvents[U][]
Type Parameters
- U extends keyof IMonitorEvents
Parameters
- type: U
Returns IMonitorEvents[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

off

off(event: U, listener: IMonitorEvents[U]): this
Type Parameters
- U extends keyof IMonitorEvents
Parameters
- event: U
- listener: IMonitorEvents[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: IMonitorEvents[U]): this
Type Parameters
- U extends keyof IMonitorEvents
Parameters
- event: U
- listener: IMonitorEvents[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: IMonitorEvents[U],
): this
Type Parameters
- U extends keyof IMonitorEvents
Parameters
- event: U
- listener: IMonitorEvents[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

pause

pause(): void
Pause monitoring without stopping it. The heartbeat loop keeps running but events are not emitted while paused. When resumed, the next poll is treated as a fresh start (no spurious events).

Returns void
- Defined in src/Monitor.ts:259

prependListener

prependListener(
event: U,
listener: IMonitorEvents[U],
): this
Type Parameters
- U extends keyof IMonitorEvents
Parameters
- event: U
- listener: IMonitorEvents[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: IMonitorEvents[U],
): this
Type Parameters
- U extends keyof IMonitorEvents
Parameters
- event: U
- listener: IMonitorEvents[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): IMonitorEvents[U][]
Type Parameters
- U extends keyof IMonitorEvents
Parameters
- type: U
Returns IMonitorEvents[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 IMonitorEvents): this
Parameters
- Optionalevent: keyof IMonitorEvents
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: IMonitorEvents[U],
): this
Type Parameters
- U extends keyof IMonitorEvents
Parameters
- event: U
- listener: IMonitorEvents[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

resume

resume(): void
Resume monitoring after a pause. previousState is cleared so the next poll behaves like the first loop (no VARIABLE_CHANGED / status events are emitted for stale data).

Returns void
- Defined in src/Monitor.ts:269

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

start

start(): Promise<void>
Returns Promise<void>
- Defined in src/Monitor.ts:201

stop

stop(): void
Returns void
- Defined in src/Monitor.ts:216

Class Monitor

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Monitor

Properties

StaticdefaultMaxListeners

Methods

addListener

Type Parameters

Parameters

Returns this

destroy

Returns void

emit

Type Parameters

Parameters

Returns boolean

eventNames

Type Parameters

Returns U[]

getMaxListeners

Returns number

isDestroyed

Returns boolean

isPaused

Returns boolean

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns IMonitorEvents[U][]

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

pause

Returns void

prependListener

Type Parameters

Parameters

Returns this

prependOnceListener

Type Parameters

Parameters

Returns this

rawListeners

Type Parameters

Parameters

Returns IMonitorEvents[U][]

removeAllListeners

Parameters

Returns this

removeListener

Type Parameters

Parameters

Returns this

resume

Returns void

setMaxListeners

Parameters

Returns this

start

Returns Promise<void>

`Static`defaultMaxListeners