Class NodeId

constructor

• new NodeId(
      identifierType?: NodeIdType | null,
      value?: string | number | Buffer<ArrayBufferLike>,
      namespace?: number,
  ): NodeId

  construct a node Id from a type, a value and a namespace index.

  Parameters

  • OptionalidentifierType: NodeIdType | null

    the nodeID type

  • Optionalvalue: string | number | Buffer<ArrayBufferLike>

    the node id value. The type of Value depends on identifierType.

  • Optionalnamespace: number

    the index of the related namespace (optional , default value = 0 )

  Returns NodeId

  Example

  const nodeId = new NodeId(NodeIdType.NUMERIC,123,1);
  Copy

identifierType

namespace

value

StaticNodeIdType

StaticnullNodeId

StaticresolveNodeId

StaticsameNodeId

displayText

• displayText(): string

  Returns string

isEmpty

• isEmpty(): boolean

  returns true if the NodeId is null or empty

  Returns boolean

toJSON

• toJSON(options?: { namespaceArray?: string[] }): string

  convert nodeId to a JSON string. same as NodeId.toString

  Parameters

  • Optionaloptions: { namespaceArray?: string[] }

  Returns string

toString

• toString(options?: { addressSpace?: any; namespaceArray?: string[] }): string

  get the string representation of the nodeID.

  Parameters

  • Optionaloptions: { addressSpace?: any; namespaceArray?: string[] }

    • OptionaladdressSpace?: any

      {AddressSpace}

    • OptionalnamespaceArray?: string[]

  Returns string

  Example

  by default, toString will return the "ns=" representation

  const nodeid = new NodeId(NodeIdType.NUMERIC, 123,1);
  console.log(nodeid.toString());
  Copy

  >"ns=1;i=123"
  Copy

  Example

  toString can also be used to make the nsu= version of the nodeid.

  const namespaceArray = ["http://opcfoundation.com/UA/","http://mynamespace2"];
  const nodeid = new NodeId(NodeIdType.STRING, "Hello",1);
  console.log(nodeid.toString({namespaceArray}));
  Copy

  >"nsu=http://mynamespace;i=123"
  Copy

  Example

  passing an addressSpace to the toString options will decorate the nodeId with the BrowseName of the node.

  const addressSpace = getAddressSpace();
  const nodeid = new NodeId(NodeIdType.NUMERIC, 123,1);
  console.log(nodeid.toString({addressSpace}));
  Copy

  >"nsu=http://mynamespace;i=123 (MyBrowseName)"
  Copy