ClientAlarmList | NodeOPCUA reference documentation

Hierarchy

EventEmitter
- ClientAlarmList

Implements

Iterable<ClientAlarm>

Index

Constructors

constructor

Properties

Accessors

length

Constructors

constructor

new ClientAlarmList(): ClientAlarmList

- Defined in packages/node-opcua-client/dist/alarms_and_conditions/client_alarm_list.d.ts:9
Returns ClientAlarmList

Properties

Readonly Static captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Readonly Static errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Accessors

length

get length(): number

- Defined in packages/node-opcua-client/dist/alarms_and_conditions/client_alarm_list.d.ts:15
Returns number

Methods

[Symbol.iterator]

[Symbol.iterator](): Iterator<ClientAlarm, any, undefined>

- Defined in packages/node-opcua-client/dist/alarms_and_conditions/client_alarm_list.d.ts:11
Returns Iterator<ClientAlarm, any, undefined>

addListener

addListener(event: string | symbol, listener: (...args: any[]) => void): ClientAlarmList

- Defined in node_modules/@types/node/events.d.ts:62
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ClientAlarmList

alarms

alarms(): ClientAlarm[]

- Defined in packages/node-opcua-client/dist/alarms_and_conditions/client_alarm_list.d.ts:12
Returns ClientAlarm[]

emit

emit(event: string | symbol, ...args: any[]): boolean

- Defined in node_modules/@types/node/events.d.ts:72
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): (string | symbol)[]

- Defined in node_modules/@types/node/events.d.ts:77
Returns (string | symbol)[]

getMaxListeners

getMaxListeners(): number

- Defined in node_modules/@types/node/events.d.ts:69
Returns number

listenerCount

listenerCount(event: string | symbol): number

- Defined in node_modules/@types/node/events.d.ts:73
Parameters
- event: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: (...args: any[]) => void): ClientAlarmList

- Defined in node_modules/@types/node/events.d.ts:66
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ClientAlarmList

on

on(eventName: "alarmChanged", handler: (alarm: ClientAlarm) => void): ClientAlarmList
on(eventName: "newAlarm", handler: (alarm: ClientAlarm) => void): ClientAlarmList

- Defined in packages/node-opcua-client/dist/alarms_and_conditions/client_alarm_list.d.ts:5
Parameters
- eventName: "alarmChanged"
- handler: (alarm: ClientAlarm) => void
  - - (alarm: ClientAlarm): void
    - Parameters
      - alarm: ClientAlarm
      Returns void
Returns ClientAlarmList
- Defined in packages/node-opcua-client/dist/alarms_and_conditions/client_alarm_list.d.ts:6
Parameters
- eventName: "newAlarm"
- handler: (alarm: ClientAlarm) => void
  - - (alarm: ClientAlarm): void
    - Parameters
      - alarm: ClientAlarm
      Returns void
Returns ClientAlarmList

once

once(event: string | symbol, listener: (...args: any[]) => void): ClientAlarmList

- Defined in node_modules/@types/node/events.d.ts:64
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ClientAlarmList

prependListener

prependListener(event: string | symbol, listener: (...args: any[]) => void): ClientAlarmList

- Defined in node_modules/@types/node/events.d.ts:75
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ClientAlarmList

prependOnceListener

prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): ClientAlarmList

- Defined in node_modules/@types/node/events.d.ts:76
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ClientAlarmList

purgeUnusedAlarms

purgeUnusedAlarms(): void

- Defined in packages/node-opcua-client/dist/alarms_and_conditions/client_alarm_list.d.ts:16
Returns void

rawListeners

rawListeners(event: string | symbol): Function[]

- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
Returns Function[]

removeAlarm

removeAlarm(eventField: EventStuff): void

- Defined in packages/node-opcua-client/dist/alarms_and_conditions/client_alarm_list.d.ts:14
Parameters
- eventField: EventStuff
Returns void

removeAllListeners

removeAllListeners(event?: string | symbol): ClientAlarmList

- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- Optional event: string | symbol
Returns ClientAlarmList

removeListener

removeListener(event: string | symbol, listener: (...args: any[]) => void): ClientAlarmList

- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ClientAlarmList

setMaxListeners

setMaxListeners(n: number): ClientAlarmList

- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- n: number
Returns ClientAlarmList

update

update(eventField: EventStuff): void

- Defined in packages/node-opcua-client/dist/alarms_and_conditions/client_alarm_list.d.ts:13
Parameters
- eventField: EventStuff
Returns void

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

- Defined in node_modules/@types/node/events.d.ts:31
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Static on

on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>

- Defined in node_modules/@types/node/events.d.ts:28
Parameters
- emitter: EventEmitter
- event: string
Returns AsyncIterableIterator<any>

Static once

once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
once(emitter: DOMEventTarget, event: string): Promise<any[]>

- Defined in node_modules/@types/node/events.d.ts:26
Parameters
- emitter: NodeEventTarget
- event: string | symbol
Returns Promise<any[]>
- Defined in node_modules/@types/node/events.d.ts:27
Parameters
- emitter: DOMEventTarget
- event: string
Returns Promise<any[]>

subscribe now with sterfive to access the online-user manual

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns ClientAlarmList

Properties

Readonly Static captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Readonly Static errorMonitor

Accessors

length

Returns number

Methods

[Symbol.iterator]

Returns Iterator<ClientAlarm, any, undefined>

addListener

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns ClientAlarmList

alarms

Returns ClientAlarm[]

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns (string | symbol)[]

getMaxListeners

Returns number

listenerCount

Parameters

event: string | symbol

Returns number

listeners

Parameters

event: string | symbol

Returns Function[]

off

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns ClientAlarmList

on

Parameters

eventName: "alarmChanged"

handler: (alarm: ClientAlarm) => void

Parameters

alarm: ClientAlarm

Returns void

Returns ClientAlarmList

Parameters

eventName: "newAlarm"

handler: (alarm: ClientAlarm) => void

Parameters

alarm: ClientAlarm

Returns void

Returns ClientAlarmList

once

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns ClientAlarmList