namespace http://opcfoundation.org/UA/
nodeClass ObjectType
typedDefinition AcknowledgeableConditionType i=2881
isAbstract false
interface UAAcknowledgeableConditionEx {
    ackedState: UATwoStateVariableEx;
    acknowledge: UAMethod;
    addComment: UAMethod;
    branchId: UAProperty<NodeId, NodeId>;
    browseName: QualifiedName;
    clientUserId: UAProperty<UAString, String>;
    comment: UAConditionVariable<LocalizedText, LocalizedText>;
    conditionClassId: UAProperty<NodeId, NodeId>;
    conditionClassName: UAProperty<LocalizedText, LocalizedText>;
    conditionName: UAProperty<UAString, String>;
    conditionRefresh: UAMethod;
    conditionRefresh2: UAMethod;
    conditionSubClassId: UAProperty<NodeId[], NodeId>;
    conditionSubClassName: UAProperty<LocalizedText[], LocalizedText>;
    confirm?: UAMethod;
    confirmedState?: UATwoStateVariableEx;
    disable: UAMethod;
    enable: UAMethod;
    enabledState: UATwoStateVariableEx;
    eventId: UAProperty<Buffer, ByteString>;
    eventNotifier: EventNotifierFlags;
    eventType: UAProperty<NodeId, NodeId>;
    hasMethods: boolean;
    lastSeverity: UAConditionVariable<number, UInt16>;
    localTime?: UAProperty<DTTimeZone, ExtensionObject>;
    message: UAProperty<LocalizedText, LocalizedText>;
    nodeClass: Object;
    nodeId: NodeId;
    nodeVersion?: UAVariableT<UAString, String>;
    onFirstBrowseAction?: ((this: BaseNode) => Promise<void>);
    quality: UAConditionVariable<StatusCode, StatusCode>;
    receiveTime: UAProperty<Date, DateTime>;
    retain: UAProperty<boolean, Boolean>;
    severity: UAProperty<number, UInt16>;
    sourceName: UAProperty<UAString, String>;
    sourceNode: UAProperty<NodeId, NodeId>;
    supportsFilteredRetain: UAProperty<boolean, Boolean>;
    time: UAProperty<Date, DateTime>;
    get accessRestrictions(): undefined | AccessRestrictionsFlag;
    get addressSpace(): IAddressSpace;
    get description(): LocalizedText;
    get displayName(): LocalizedText[];
    get modellingRule(): undefined | ModellingRuleType;
    get namespace(): INamespace;
    get namespaceIndex(): number;
    get namespaceUri(): string;
    get parent(): null | BaseNode;
    get parentNodeId(): undefined | NodeId;
    get rolePermissions(): undefined | RolePermissionType[];
    get typeDefinition(): NodeId;
    get typeDefinitionObj(): UAObjectType;
    [captureRejectionSymbol]?<K>(error: Error, event: string | symbol, ...args: AnyRest): void;
    acknowledgeAndAutoConfirmBranch(branch: ConditionSnapshot, comment: LocalizedText | LocalizedTextLike): void;
    addListener<K>(eventName: string | symbol, listener: ((...args: any[]) => void)): this;
    addReference(options: AddReferenceOpts): void;
    allReferences(): UAReference[];
    autoConfirmBranch(branch: ConditionSnapshot, comment: LocalizedTextLike): void;
    browseNode(browseDescription: BrowseDescriptionOptions2, session?: ISessionContext): ReferenceDescription[];
    browseNodeByTargetName(relativePathElement: RelativePathElement, isLast: boolean): NodeId[];
    clone(options: CloneOptions, optionalFilter?: CloneFilter, extraInfo?: CloneExtraInfo): UAObject;
    conditionOfNode(): null | UAObject | UAVariable;
    createBranch(): ConditionSnapshot;
    currentBranch(): ConditionSnapshot;
    deleteBranch(branch: ConditionSnapshot): void;
    emit<K>(eventName: string | symbol, ...args: AnyRest): boolean;
    eventNames(): (string | symbol)[];
    findReference(referenceType: string | NodeId | UAReferenceType, isForward?: boolean): null | UAReference;
    findReferences(referenceType: string | NodeId | UAReferenceType, isForward?: boolean): UAReference[];
    findReferencesAsObject(referenceType: string | NodeId | UAReferenceType, isForward?: boolean): BaseNode[];
    findReferencesEx(referenceType: string | NodeId | UAReferenceType, browseDirection?: BrowseDirection): UAReference[];
    findReferencesExAsObject(referenceType: string | NodeId | UAReferenceType, browseDirection?: BrowseDirection): BaseNode[];
    fullName(): string;
    getAccessRestrictions(inherited: boolean): AccessRestrictionsFlag;
    getAggregates(): BaseNode[];
    getBranchCount(): number;
    getBranches(): ConditionSnapshot[];
    getBranchIds(): NodeId[];
    getChildByName(browseName: QualifiedNameOptions): null | BaseNode;
    getChildByName(browseName: string, namespaceIndex?: number): null | BaseNode;
    getComponentByName(componentName: QualifiedNameOptions): null | UAObject | UAVariable;
    getComponentByName(componentName: string, namespaceIndex?: number): null | UAObject | UAVariable;
    getComponents(): BaseNode[];
    getDisplayName(locale?: string): string;
    getEnabledState(): boolean;
    getEnabledStateAsString(): string;
    getEventSourceOfs(): BaseNode[];
    getEventSources(): BaseNode[];
    getFolderElementByName(browseName: QualifiedNameOptions): null | BaseNode;
    getFolderElementByName(browseName: string, namespaceIndex?: number): null | BaseNode;
    getMaxListeners(): number;
    getMethodById(nodeId: NodeId): null | UAMethod;
    getMethodByName(methodName: QualifiedNameOptions): null | UAMethod;
    getMethodByName(methodName: string, namespaceIndex?: number): null | UAMethod;
    getMethods(): UAMethod[];
    getNotifiers(): BaseNode[];
    getProperties(): BaseNode[];
    getPropertyByName(propertyName: QualifiedNameOptions): null | UAVariable;
    getPropertyByName(propertyName: string, namespaceIndex?: number): null | UAVariable;
    getRolePermissions(inherited: boolean): null | RolePermissionType[];
    install_extra_properties(): void;
    isDisposed(): boolean;
    listenerCount<K>(eventName: string | symbol, listener?: Function): number;
    listeners<K>(eventName: string | symbol): Function[];
    off<K>(eventName: string | symbol, listener: ((...args: any[]) => void)): this;
    on(eventName: string, eventHandler: any): this;
    once<K>(eventName: string | symbol, listener: ((...args: any[]) => void)): this;
    prependListener<K>(eventName: string | symbol, listener: ((...args: any[]) => void)): this;
    prependOnceListener<K>(eventName: string | symbol, listener: ((...args: any[]) => void)): this;
    raiseConditionEvent(branch: ConditionSnapshot, renewEventId: boolean): void;
    raiseEvent(eventType: BaseNode | EventTypeLike, eventData: RaiseEventData): void;
    raiseNewBranchState(branch: ConditionSnapshot): void;
    raiseNewCondition(conditionInfo: ConditionInfoOptions): void;
    rawListeners<K>(eventName: string | symbol): Function[];
    readAttribute(context: null | ISessionContext, attributeId: AttributeIds, indexRange?: NumericRange, dataEncoding?: null | QualifiedNameLike): DataValue;
    removeAllListeners(eventName?: string | symbol): this;
    removeListener<K>(eventName: string | symbol, listener: ((...args: any[]) => void)): this;
    removeReference(referenceOpts: AddReferenceOpts): void;
    setAccessRestrictions(accessRestrictions: AccessRestrictionsFlag): void;
    setDescription(value: null | LocalizedTextLike): void;
    setDisplayName(value: LocalizedTextLike | LocalizedTextLike[]): void;
    setEnabledState(requestedEnabledState: boolean, options?: ISetStateOptions): StatusCode;
    setEventNotifier(eventNotifierFlags: EventNotifierFlags): void;
    setLocalTime(time: TimeZoneDataType): void;
    setMaxListeners(n: number): this;
    setReceiveTime(time: Date): void;
    setRolePermissions(rolePermissions: RolePermissionTypeOptions[]): void;
    setSourceName(name: string): void;
    setSourceNode(node: NodeId | BaseNode): void;
    setTime(time: Date): void;
    writeAttribute(context: null | ISessionContext, writeValue: WriteValueOptions, callback: ((err: null | Error, statusCode?: StatusCode) => void)): void;
}

Hierarchy (view full)

Properties

Accessors

Methods

Properties

ackedState: UATwoStateVariableEx
acknowledge: UAMethod
addComment: UAMethod
browseName: QualifiedName
clientUserId: UAProperty<UAString, String>
conditionClassId: UAProperty<NodeId, NodeId>
conditionClassName: UAProperty<LocalizedText, LocalizedText>
conditionName: UAProperty<UAString, String>
conditionRefresh: UAMethod
conditionRefresh2: UAMethod
conditionSubClassId: UAProperty<NodeId[], NodeId>
conditionSubClassName: UAProperty<LocalizedText[], LocalizedText>
confirm?: UAMethod
confirmedState?: UATwoStateVariableEx
disable: UAMethod
enable: UAMethod
enabledState: UATwoStateVariableEx
eventId: UAProperty<Buffer, ByteString>
eventNotifier: EventNotifierFlags
eventType: UAProperty<NodeId, NodeId>
hasMethods: boolean
lastSeverity: UAConditionVariable<number, UInt16>
nodeClass: Object
nodeId: NodeId
nodeVersion?: UAVariableT<UAString, String>

NodeVersion (Optional) String The NodeVersion Property is used to indicate the version of a Node. The NodeVersion Property is updated each time a Reference is added or deleted to the Node the Property belongs to. Attribute value changes do not cause the NodeVersion to change. Clients may read the NodeVersion Property or subscribe to it to determine when the structure of a Node has changed.

onFirstBrowseAction?: ((this: BaseNode) => Promise<void>)
receiveTime: UAProperty<Date, DateTime>
retain: UAProperty<boolean, Boolean>
severity: UAProperty<number, UInt16>
sourceName: UAProperty<UAString, String>
sourceNode: UAProperty<NodeId, NodeId>
supportsFilteredRetain: UAProperty<boolean, Boolean>
time: UAProperty<Date, DateTime>

Accessors

  • get accessRestrictions(): undefined | AccessRestrictionsFlag
  • Returns undefined | AccessRestrictionsFlag

  • get addressSpace(): IAddressSpace
  • Returns IAddressSpace

  • get description(): LocalizedText
  • Returns LocalizedText

  • get displayName(): LocalizedText[]
  • Returns LocalizedText[]

  • get modellingRule(): undefined | ModellingRuleType
  • Returns undefined | ModellingRuleType

  • get namespace(): INamespace
  • Returns INamespace

  • get namespaceIndex(): number
  • Returns number

  • get namespaceUri(): string
  • Returns string

  • get parent(): null | BaseNode
  • Returns null | BaseNode

  • get parentNodeId(): undefined | NodeId
  • Returns undefined | NodeId

  • get rolePermissions(): undefined | RolePermissionType[]
  • Returns undefined | RolePermissionType[]

  • get typeDefinition(): NodeId
  • Returns NodeId

  • get typeDefinitionObj(): UAObjectType
  • Returns UAObjectType

Methods

  • Type Parameters

    • K

    Parameters

    • error: Error
    • event: string | symbol
    • Rest...args: AnyRest

    Returns void

  • Alias for emitter.on(eventName, listener).

    Type Parameters

    • K

    Parameters

    • eventName: string | symbol
    • listener: ((...args: any[]) => void)
        • (...args): void
        • Parameters

          • Rest...args: any[]

          Returns void

    Returns this

    v0.1.26

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

    Returns true if the event had listeners, false otherwise.

    import { EventEmitter } from 'node:events';
    const myEmitter = new EventEmitter();

    // First listener
    myEmitter.on('event', function firstListener() {
    console.log('Helloooo! first listener');
    });
    // Second listener
    myEmitter.on('event', function secondListener(arg1, arg2) {
    console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
    });
    // Third listener
    myEmitter.on('event', function thirdListener(...args) {
    const parameters = args.join(', ');
    console.log(`event with parameters ${parameters} in third listener`);
    });

    console.log(myEmitter.listeners('event'));

    myEmitter.emit('event', 1, 2, 3, 4, 5);

    // Prints:
    // [
    // [Function: firstListener],
    // [Function: secondListener],
    // [Function: thirdListener]
    // ]
    // Helloooo! first listener
    // event with parameters 1, 2 in second listener
    // event with parameters 1, 2, 3, 4, 5 in third listener

    Type Parameters

    • K

    Parameters

    • eventName: string | symbol
    • Rest...args: AnyRest

    Returns boolean

    v0.1.26

  • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

    import { EventEmitter } from 'node:events';

    const myEE = new EventEmitter();
    myEE.on('foo', () => {});
    myEE.on('bar', () => {});

    const sym = Symbol('symbol');
    myEE.on(sym, () => {});

    console.log(myEE.eventNames());
    // Prints: [ 'foo', 'bar', Symbol(symbol) ]

    Returns (string | symbol)[]

    v6.0.0

  • find the the references that are strictly of type reference.

    The isForward boolean flag specifies the direction of the references to be looked for.

    Forward direction is implied if omitted.

    • will throw an exception if more than one reference exists with the referenceType.
    • will return null if no reference exists.

    Parameters

    Returns null | UAReference

  • find all the references that are strictly of type reference. The isForward boolean flag specifies the direction of the references to be looked for.

    Forward direction is implied if omitted.

    Parameters

    Returns UAReference[]

  • find all the nodes that are referenced by references strictly of type reference.

    The isForward boolean flag specifies the direction of the references to be looked for.

    Forward direction is implied if omitted.

    • will throw an exception if more than one reference exists with the referenceType.
    • will return null if no reference exists.

    Parameters

    Returns BaseNode[]

  • find all the references that are of type reference or a sub type of reference, in the direction specified by browseDirection

    • BrowseDirection.Forward direction is implied if browseDirection flags is omitted.

    Parameters

    Returns UAReference[]

  • find all the nodes that are referenced by references of type reference or a sub type of reference, in the direction specified by browseDirection

    • BrowseDirection.Forward direction is implied if browseDirection flags is omitted.

    Parameters

    Returns BaseNode[]

  • return a complete name of this object by pre-pending name of its parent(s) to its own name

    Returns string

  • get effective accessRestrictions if (inherited is true) and node has no accessRestrictions, then default accessRestriction from namespace is returned if (inherited is false) and node has no accessRestrictions, then AccessRestrictionsFlag.None is returned

    Parameters

    • inherited: boolean

    Returns AccessRestrictionsFlag

  • Returns number

  • Returns NodeId[]

  • Parameters

    • Optionallocale: string

      the locale of the text to return (e.g. en-EN)

    Returns string

  • Returns boolean

  • Returns string

  • return a array of the objects for which this node is an EventSource nodes = HasEventSource => self

    Returns BaseNode[]

  • return a array with the event source of this object. self = HasEventSource => nodes

    Returns BaseNode[]

  • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    Returns number

    v1.0.0

  • private

    Returns void

  • Returns boolean

  • Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

    Type Parameters

    • K

    Parameters

    • eventName: string | symbol

      The name of the event being listened for

    • Optionallistener: Function

      The event handler function

    Returns number

    v3.2.0

  • Returns a copy of the array of listeners for the event named eventName.

    server.on('connection', (stream) => {
    console.log('someone connected!');
    });
    console.log(util.inspect(server.listeners('connection')));
    // Prints: [ [Function] ]

    Type Parameters

    • K

    Parameters

    • eventName: string | symbol

    Returns Function[]

    v0.1.26

  • Alias for emitter.removeListener().

    Type Parameters

    • K

    Parameters

    • eventName: string | symbol
    • listener: ((...args: any[]) => void)
        • (...args): void
        • Parameters

          • Rest...args: any[]

          Returns void

    Returns this

    v10.0.0

  • Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

    server.on('connection', (stream) => {
    console.log('someone connected!');
    });

    Returns a reference to the EventEmitter, so that calls can be chained.

    By default, event listeners are invoked in the order they are added. The emitter.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

    import { EventEmitter } from 'node:events';
    const myEE = new EventEmitter();
    myEE.on('foo', () => console.log('a'));
    myEE.prependListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    // b
    // a

    Parameters

    • eventName: string

      The name of the event.

    • eventHandler: any

    Returns this

    v0.1.101

  • Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

    server.once('connection', (stream) => {
    console.log('Ah, we have our first user!');
    });

    Returns a reference to the EventEmitter, so that calls can be chained.

    By default, event listeners are invoked in the order they are added. The emitter.prependOnceListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

    import { EventEmitter } from 'node:events';
    const myEE = new EventEmitter();
    myEE.once('foo', () => console.log('a'));
    myEE.prependOnceListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    // b
    // a

    Type Parameters

    • K

    Parameters

    • eventName: string | symbol

      The name of the event.

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

      The callback function

        • (...args): void
        • Parameters

          • Rest...args: any[]

          Returns void

    Returns this

    v0.3.0

  • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

    server.prependListener('connection', (stream) => {
    console.log('someone connected!');
    });

    Returns a reference to the EventEmitter, so that calls can be chained.

    Type Parameters

    • K

    Parameters

    • eventName: string | symbol

      The name of the event.

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

      The callback function

        • (...args): void
        • Parameters

          • Rest...args: any[]

          Returns void

    Returns this

    v6.0.0

  • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

    server.prependOnceListener('connection', (stream) => {
    console.log('Ah, we have our first user!');
    });

    Returns a reference to the EventEmitter, so that calls can be chained.

    Type Parameters

    • K

    Parameters

    • eventName: string | symbol

      The name of the event.

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

      The callback function

        • (...args): void
        • Parameters

          • Rest...args: any[]

          Returns void

    Returns this

    v6.0.0

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

    import { EventEmitter } from 'node:events';
    const emitter = new EventEmitter();
    emitter.once('log', () => console.log('log once'));

    // Returns a new Array with a function `onceWrapper` which has a property
    // `listener` which contains the original listener bound above
    const listeners = emitter.rawListeners('log');
    const logFnWrapper = listeners[0];

    // Logs "log once" to the console and does not unbind the `once` event
    logFnWrapper.listener();

    // Logs "log once" to the console and removes the listener
    logFnWrapper();

    emitter.on('log', () => console.log('log persistently'));
    // Will return a new Array with a single function bound by `.on()` above
    const newListeners = emitter.rawListeners('log');

    // Logs "log persistently" twice
    newListeners[0]();
    emitter.emit('log');

    Type Parameters

    • K

    Parameters

    • eventName: string | symbol

    Returns Function[]

    v9.4.0

  • Removes all listeners, or those of the specified eventName.

    It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

    Returns a reference to the EventEmitter, so that calls can be chained.

    Parameters

    • OptionaleventName: string | symbol

    Returns this

    v0.1.26

  • Removes the specified listener from the listener array for the event named eventName.

    const callback = (stream) => {
    console.log('someone connected!');
    };
    server.on('connection', callback);
    // ...
    server.removeListener('connection', callback);

    removeListener() will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener() must be called multiple times to remove each instance.

    Once an event is emitted, all listeners attached to it at the time of emitting are called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution will not remove them fromemit() in progress. Subsequent events behave as expected.

    import { EventEmitter } from 'node:events';
    class MyEmitter extends EventEmitter {}
    const myEmitter = new MyEmitter();

    const callbackA = () => {
    console.log('A');
    myEmitter.removeListener('event', callbackB);
    };

    const callbackB = () => {
    console.log('B');
    };

    myEmitter.on('event', callbackA);

    myEmitter.on('event', callbackB);

    // callbackA removes listener callbackB but it will still be called.
    // Internal listener array at time of emit [callbackA, callbackB]
    myEmitter.emit('event');
    // Prints:
    // A
    // B

    // callbackB is now removed.
    // Internal listener array [callbackA]
    myEmitter.emit('event');
    // Prints:
    // A

    Because listeners are managed using an internal array, calling this will change the position indices of any listener registered after the listener being removed. This will not impact the order in which listeners are called, but it means that any copies of the listener array as returned by the emitter.listeners() method will need to be recreated.

    When a single function has been added as a handler multiple times for a single event (as in the example below), removeListener() will remove the most recently added instance. In the example the once('ping') listener is removed:

    import { EventEmitter } from 'node:events';
    const ee = new EventEmitter();

    function pong() {
    console.log('pong');
    }

    ee.on('ping', pong);
    ee.once('ping', pong);
    ee.removeListener('ping', pong);

    ee.emit('ping');
    ee.emit('ping');

    Returns a reference to the EventEmitter, so that calls can be chained.

    Type Parameters

    • K

    Parameters

    • eventName: string | symbol
    • listener: ((...args: any[]) => void)
        • (...args): void
        • Parameters

          • Rest...args: any[]

          Returns void

    Returns this

    v0.1.26

  • Parameters

    Returns void

  • Parameters

    • requestedEnabledState: boolean
    • Optionaloptions: ISetStateOptions

    Returns StatusCode

  • Parameters

    Returns void

  • Parameters

    Returns void

  • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

    Returns a reference to the EventEmitter, so that calls can be chained.

    Parameters

    • n: number

    Returns this

    v0.3.5

  • Parameters

    • time: Date

    Returns void

  • Parameters

    • name: string

    Returns void

  • Parameters

    Returns void

  • Parameters

    • time: Date

    Returns void

  • Parameters

    Returns void