node-opcua | NodeOPCUA reference documentation

Index

Enumerations

Classes

Interfaces

Type aliases

Events

RegisterServerManager

Variables

Functions

Type aliases

AccessLevelFlagString

AccessLevelString

AccessLevelString: string

AddCommentEventHandler

AddCommentEventHandler: (eventId: Buffer | null, comment: LocalizedText, branch: ConditionSnapshot) => void

Type declaration

- (eventId: Buffer | null, comment: LocalizedText, branch: ConditionSnapshot): void
- Parameters
  - eventId: Buffer | null
  - comment: LocalizedText
  - branch: ConditionSnapshot
  Returns void

AddStateVariableOptionals

AddStateVariableOptionals: "EffectiveDisplayName" | "Name" | "Number" | string

AddTwoStateVariableOptionals

AddTwoStateVariableOptionals: AddStateVariableOptionals | "TransitionTime" | "EffectiveTransitionTime" | "TrueState" | "FalseState"

BindVariableOptions

BindVariableOptions: BindVariableOptionsVariation1 | BindVariableOptionsVariation2 | BindVariableOptionsVariation3 | BindVariableOptionsVariation4

BrowseDescriptionLike

BrowseDescriptionLike: string | BrowseDescriptionOptions

Byte

Byte: UInt8

ByteString

ByteString: Buffer

CallMethodRequestLike

CallMethodRequestLike: CallMethodRequestOptions

Callback

Callback<T>: (err: Error | null, result?: T) => void

Type parameters

Type declaration

- (err: Error | null, result?: T): void
- Parameters
  - err: Error | null
  - Optional result: T
  Returns void

Callback2

Callback2<T>: (err: Error | null, result?: T) => void

Type parameters

Type declaration

- (err: Error | null, result?: T): void
- Parameters
  - err: Error | null
  - Optional result: T
  Returns void

CallbackT

CallbackT<T>: (err: Error | null, result?: T) => void

Type parameters

Type declaration

- (err: Error | null, result?: T): void
- Parameters
  - err: Error | null
  - Optional result: T
  Returns void

CallbackWithData

CallbackWithData: CallbackT<Buffer>

CharArray

CharArray: string

ClientHandle

ClientHandle: number

ClosingReason

ClosingReason: "Timeout" | "Terminated" | "CloseSession" | "Forcing"

ConstructorFunc

ConstructorFunc: (...args: any[]) => BaseUAObject

Type declaration

- (...args: any[]): BaseUAObject
- Parameters
  - Rest ...args: any[]
  Returns BaseUAObject

ContinuationPoint

ContinuationPoint: ByteString

Counter

Counter: number

CreateMonitoredItemHook

CreateMonitoredItemHook: (subscription: Subscription, monitoredItem: MonitoredItemBase) => Promise<StatusCode>

Type declaration

- (subscription: Subscription, monitoredItem: MonitoredItemBase): Promise<StatusCode>
- Parameters
  - subscription: Subscription
  - monitoredItem: MonitoredItemBase
  Returns Promise<StatusCode>

CreateMonitoredItemsRequestLike

CreateMonitoredItemsRequestLike: CreateMonitoredItemsRequestOptions

CreateNodeOptions

CreateNodeOptions: any

CreateSecureChannelCallbackFunc

CreateSecureChannelCallbackFunc: (err: Error | null, secureChannel?: ClientSecureChannelLayer) => void

Type declaration

- (err: Error | null, secureChannel?: ClientSecureChannelLayer): void
- Parameters
  - err: Error | null
  - Optional secureChannel: ClientSecureChannelLayer
  Returns void

CreateSubscriptionRequestLike

CreateSubscriptionRequestLike: CreateSubscriptionRequestOptions

DataValueLike

DataValueLike: DataValueOptions | DataValue

DateTime

DateTime: Date | DateWithPicoseconds | null

DeleteMonitoredItemHook

DeleteMonitoredItemHook: (subscription: Subscription, monitoredItem: MonitoredItemBase) => Promise<StatusCode>

Type declaration

- (subscription: Subscription, monitoredItem: MonitoredItemBase): Promise<StatusCode>
- Parameters
  - subscription: Subscription
  - monitoredItem: MonitoredItemBase
  Returns Promise<StatusCode>

DeleteMonitoredItemsRequestLike

DeleteMonitoredItemsRequestLike: DeleteMonitoredItemsRequestOptions

DeleteSubscriptionsRequestLike

DeleteSubscriptionsRequestLike: DeleteSubscriptionsRequestOptions

Double

Double: number

Duration

Duration: number

ErrorCallback

ErrorCallback: (err?: Error) => void

Type declaration

- (err?: Error): void
- Parameters
  - Optional err: Error
  Returns void

EventTypeLike

EventTypeLike: string | NodeId | UAEventType

FindEndpointCallback

FindEndpointCallback: (err: Error | null, result?: FindEndpointResult) => void

Type declaration

- (err: Error | null, result?: FindEndpointResult): void
- Parameters
  - err: Error | null
  - Optional result: FindEndpointResult
  Returns void

FindServersOnNetworkRequestLike

FindServersOnNetworkRequestLike: FindServersOnNetworkRequestOptions

FindServersRequestLike

FindServersRequestLike: FindServersRequestOptions

Float

Float: number

GetFunc

GetFunc: (this: UAVariable) => Variant

Type declaration

- (this: UAVariable): Variant
- Parameters
  - this: UAVariable
  Returns Variant

Guid

Guid: string

HistoryReadFunc

HistoryReadFunc: (context: ISessionContext, historyReadDetails: ReadRawModifiedDetails | ReadEventDetails | ReadProcessedDetails | ReadAtTimeDetails, indexRange: NumericRange | null, dataEncoding: QualifiedNameLike | null, continuationData: ContinuationData, callback: CallbackT<HistoryReadResult>) => void

Type declaration

- (context: ISessionContext, historyReadDetails: ReadRawModifiedDetails | ReadEventDetails | ReadProcessedDetails | ReadAtTimeDetails, indexRange: NumericRange | null, dataEncoding: QualifiedNameLike | null, continuationData: ContinuationData, callback: CallbackT<HistoryReadResult>): void
- Parameters
  - context: ISessionContext
  - historyReadDetails: ReadRawModifiedDetails | ReadEventDetails | ReadProcessedDetails | ReadAtTimeDetails
  - indexRange: NumericRange | null
  - dataEncoding: QualifiedNameLike | null
  - continuationData: ContinuationData
  - callback: CallbackT<HistoryReadResult>
  Returns void

IHistoricalDataNodeOptions

IHistoricalDataNodeOptions: IVariableHistorianOptions | { historian: IVariableHistorian }

Int16

Int16: number

Int32

Int32: number

Int64

Int64: UInt32[]

Int8

Int8: number

LocaleId

LocaleId: UAString

LocalizedTextLike

LocalizedTextLike: LocalizedTextOptions | string

MethodFunctor

MethodFunctor: MethodFunctorC | MethodFunctorA

MethodFunctorA

MethodFunctorA: (this: UAMethod, inputArguments: Variant[], context: ISessionContext) => Promise<CallMethodResultOptions>

Type declaration

- (this: UAMethod, inputArguments: Variant[], context: ISessionContext): Promise<CallMethodResultOptions>
- Parameters
  - this: UAMethod
  - inputArguments: Variant[]
  - context: ISessionContext
  Returns Promise<CallMethodResultOptions>

MethodFunctorC

MethodFunctorC: (this: UAMethod, inputArguments: Variant[], context: ISessionContext, callback: CallbackT<CallMethodResultOptions>) => void

Type declaration

- (this: UAMethod, inputArguments: Variant[], context: ISessionContext, callback: CallbackT<CallMethodResultOptions>): void
- Parameters
  - this: UAMethod
  - inputArguments: Variant[]
  - context: ISessionContext
  - callback: CallbackT<CallMethodResultOptions>
  Returns void

MethodId

MethodId: NodeIdLike

ModellingRuleType

ModifyMonitoredItemsRequestLike

ModifyMonitoredItemsRequestLike: ModifyMonitoredItemsRequestOptions

ModifySubscriptionRequestLike

ModifySubscriptionRequestLike: ModifySubscriptionRequestOptions

NodeIdLike

NodeIdLike: string | NodeId | number

NodeIdLikeOrWithNodeId

NodeIdLikeOrWithNodeId: NodeIdLike | { nodeId: NodeId }

Notification

Notification: DataChangeNotification | EventNotificationList | StatusChangeNotification

NumberType

NumberType: number | number[]

ObjectMap

ObjectMap: {}

Type declaration

[key: string]: Pojo

Pojo

Pojo: Record<string, unknown>

PseudoVariant

PseudoVariantNumber

QualifiedNameLike

QualifiedNameLike: QualifiedNameOptions | string

ResponseCallback

ResponseCallback<T>: (err: Error | null, response?: T) => void

Type parameters

Type declaration

- (err: Error | null, response?: T): void
- Parameters
  - err: Error | null
  - Optional response: T
  Returns void

SByte

SByte: Int8

SecurityHeader

SecurityHeader: AsymmetricAlgorithmSecurityHeader | SymmetricAlgorithmSecurityHeader

SetFunc

SetFunc: VariableSetter | null

SetMonitoringModeRequestLike

SetMonitoringModeRequestLike: SetMonitoringModeRequestOptions

StatusCodeCallback

StatusCodeCallback: CallbackT<StatusCode>

StringGetter

StringGetter: () => string

Type declaration

- (): string
- Returns string

SubscriptionId

SubscriptionId: number

TimestampGetFunc

TimestampGetFunc: VariableDataValueGetterSync | VariableDataValueGetterPromise | VariableDataValueGetterCallback

TimestampSetFunc

TimestampSetFunc: VariableDataValueSetterWithCallback | VariableDataValueSetterWithPromise

TransferSubscriptionsRequestLike

TransferSubscriptionsRequestLike: TransferSubscriptionsRequestOptions

TransitionSelector

TransitionSelector: (transitions: UATransitionEx[], fromState: UAState, toState: UAState) => UATransitionEx | null

Type declaration

- (transitions: UATransitionEx[], fromState: UAState, toState: UAState): UATransitionEx | null
- Parameters
  - transitions: UATransitionEx[]
  - fromState: UAState
  - toState: UAState
  Returns UATransitionEx | null

UABoolean

UABoolean: boolean

UAClonable

UAClonable: UAObject | UAVariable | UAMethod

UAString

UAString: string | null

UInt16

UInt16: number

UInt32

UInt32: number

UInt64

UInt64: UInt32[]

UInt8

UInt8: number

UserIdentityInfo

UserIdentityInfo: AnonymousIdentity | UserIdentityInfoX509 | UserIdentityInfoUserName

UserManagerOptions

UserManagerOptions: IUserManagerEx | UAUserManagerBase

UtcTime

UtcTime: DateTime

ValidUserAsyncFunc

ValidUserAsyncFunc: (this: ServerSession, username: string, password: string, callback: (err: Error | null, isAuthorized?: boolean) => void) => void

Type declaration

- (this: ServerSession, username: string, password: string, callback: (err: Error | null, isAuthorized?: boolean) => void): void
- Parameters
  - this: ServerSession
  - username: string
  - password: string
  - callback: (err: Error | null, isAuthorized?: boolean) => void
    - - (err: Error | null, isAuthorized?: boolean): void
      - Parameters
        
        err: Error | null
        
        Optional isAuthorized: boolean
        
        Returns void
  Returns void

ValidUserFunc

ValidUserFunc: (this: ServerSession, username: string, password: string) => boolean

Type declaration

- (this: ServerSession, username: string, password: string): boolean
- Parameters
  - this: ServerSession
  - username: string
  - password: string
  Returns boolean

VariableDataValueGetterCallback

VariableDataValueGetterCallback: (this: UAVariable, callback: CallbackT<DataValue>) => void

Type declaration

- (this: UAVariable, callback: CallbackT<DataValue>): void
- Parameters
  - this: UAVariable
  - callback: CallbackT<DataValue>
  Returns void

VariableDataValueGetterPromise

VariableDataValueGetterPromise: (this: UAVariable) => Promise<DataValue>

Type declaration

- (this: UAVariable): Promise<DataValue>
- Parameters
  - this: UAVariable
  Returns Promise<DataValue>

VariableDataValueGetterSync

VariableDataValueGetterSync: (this: UAVariable) => DataValue

Type declaration

- (this: UAVariable): DataValue
- Parameters
  - this: UAVariable
  Returns DataValue

VariableDataValueSetterWithCallback

VariableDataValueSetterWithCallback: (this: UAVariable, dataValue: DataValue, callback: CallbackT<StatusCode>) => void

Type declaration

- (this: UAVariable, dataValue: DataValue, callback: CallbackT<StatusCode>): void
- Parameters
  - this: UAVariable
  - dataValue: DataValue
  - callback: CallbackT<StatusCode>
  Returns void

VariableDataValueSetterWithPromise

VariableDataValueSetterWithPromise: (this: UAVariable, dataValue: DataValue) => Promise<StatusCode>

Type declaration

- (this: UAVariable, dataValue: DataValue): Promise<StatusCode>
- Parameters
  - this: UAVariable
  - dataValue: DataValue
  Returns Promise<StatusCode>

VariableSetter

VariableSetter: VariableSetterVariation1 | VariableSetterVariation2

VariableSetterVariation1

VariableSetterVariation1: (this: UAVariable, value: Variant) => StatusCode

Type declaration

- (this: UAVariable, value: Variant): StatusCode
- Parameters
  - this: UAVariable
  - value: Variant
  Returns StatusCode

VariableSetterVariation2

VariableSetterVariation2: (this: UAVariable, value: Variant, callback: CallbackT<StatusCode>) => void

Type declaration

- (this: UAVariable, value: Variant, callback: CallbackT<StatusCode>): void
- Parameters
  - this: UAVariable
  - value: Variant
  - callback: CallbackT<StatusCode>
  Returns void

VariantByteString

VariantByteString: VariantT<Buffer, ByteString>

VariantDouble

VariantDouble: VariantT<number, Double>

VariantLike

VariantLike: VariantOptions

VerifyBufferFunc

VerifyBufferFunc: (chunk: Buffer) => boolean

Type declaration

- (chunk: Buffer): boolean
- Parameters
  - chunk: Buffer
  Returns boolean

WellKnownRolesSemiColumnSeparated

WellKnownRolesSemiColumnSeparated: string

OPC Unified Architecture, Part 3 13 Release 1.04 4.8.2 Well Known Roles All Servers should support the well-known Roles which are defined in Table 2. The NodeIds for the well-known Roles are defined in Part 6. Table 2 – Well-Known Roles BrowseName Suggested Permissions

Anonymous The Role has very limited access for use when a Session has anonymous credentials. AuthenticatedUser The Role has limited access for use when a Session has valid non-anonymous credentials but has not been explicitly granted access to a Role. Observer The Role is allowed to browse, read live data, read historical data/events or subscribe to data/events. Operator The Role is allowed to browse, read live data, read historical data/events or subscribe to data/events. In addition, the Session is allowed to write some live data and call some Methods. Engineer The Role is allowed to browse, read/write configuration data, read historical data/events, call Methods or subscribe to data/events. Supervisor The Role is allowed to browse, read live data, read historical data/events, call Methods or subscribe to data/events. ConfigureAdmin The Role is allowed to change the non-security related config SecurityAdmin The Role is allowed to change security related settings.

WithSessionFunc

WithSessionFunc: (session: ClientSession) => Promise<void>

Type declaration

- (session: ClientSession): Promise<void>
- Parameters
  - session: ClientSession
  Returns Promise<void>

WithSessionFuncP

WithSessionFuncP<T>: (session: ClientSession) => Promise<T>

Type parameters

Type declaration

- (session: ClientSession): Promise<T>
- Parameters
  - session: ClientSession
  Returns Promise<T>

WithSubscriptionFunc

WithSubscriptionFunc: (session: ClientSession, subscription: ClientSubscription) => Promise<void>

Type declaration

- (session: ClientSession, subscription: ClientSubscription): Promise<void>
- Parameters
  - session: ClientSession
  - subscription: ClientSubscription
  Returns Promise<void>

WithSubscriptionFuncP

WithSubscriptionFuncP<T>: (session: ClientSession, subscription: ClientSubscription) => Promise<T>

Type parameters

Type declaration

- (session: ClientSession, subscription: ClientSubscription): Promise<T>
- Parameters
  - session: ClientSession
  - subscription: ClientSubscription
  Returns Promise<T>

XmlLoaderAsyncFunc

XmlLoaderAsyncFunc: (nodeset2xmlUri: string) => Promise<string>

Type declaration

- (nodeset2xmlUri: string): Promise<string>
- Parameters
  - nodeset2xmlUri: string
  Returns Promise<string>

XmlLoaderFunc

XmlLoaderFunc: (nodeset2xmlUri: string, callback: CallbackT<string>) => void

Type declaration

- (nodeset2xmlUri: string, callback: CallbackT<string>): void
- Parameters
  - nodeset2xmlUri: string
  - callback: CallbackT<string>
  Returns void

Events

RegisterServerManager

RegisterServerManager:

RegisterServerManager is responsible to Register an opcua server on a LDS or LDS-ME server This class takes in charge :

the initial registration of a server
the regular registration renewal (every 8 minutes or so ...)
dealing with cases where LDS is not up and running when server starts. ( in this case the connection will be continuously attempted using the infinite back-off strategy
the un-registration of the server ( during shutdown for instance)

Events:

Emitted when the server is trying to registered the LDS but when the connection to the lds has failed serverRegistrationPending is sent when the backoff signal of the connection process is rained

param
param
param

constructor

new RegisterServerManager(options: RegisterServerManagerOptions): RegisterServerManager

- Defined in node-opcua-server/dist/register_server_manager.d.ts:80
Parameters
- options: RegisterServerManagerOptions
Returns RegisterServerManager

discoveryServerEndpointUrl

discoveryServerEndpointUrl: string

timeout

timeout: number

_emitEvent

_emitEvent(eventName: string): void

- Defined in node-opcua-server/dist/register_server_manager.d.ts:82
Parameters
- eventName: string
Returns void

_setState

_setState(status: RegisterServerManagerStatus): void

- Defined in node-opcua-server/dist/register_server_manager.d.ts:83
Parameters
- status: RegisterServerManagerStatus
Returns void

_trigger_next

_trigger_next(): void

- Defined in node-opcua-server/dist/register_server_manager.d.ts:86
Returns void

dispose

dispose(): void

- Defined in node-opcua-server/dist/register_server_manager.d.ts:81
Returns void

start

start(callback: ErrorCallback): void

- Defined in node-opcua-server/dist/register_server_manager.d.ts:84
Parameters
- callback: ErrorCallback
Returns void

stop

stop(callback: ErrorCallback): void

- Defined in node-opcua-server/dist/register_server_manager.d.ts:87
Parameters
- callback: ErrorCallback
Returns void

Variables

Const NamespaceOptions

NamespaceOptions: { nodeIdNameSeparator: string }

Type declaration

nodeIdNameSeparator: string

NamespacePrivate

NamespacePrivate: (options: any) => NamespacePrivate

Type declaration

- (options: any): NamespacePrivate
- Parameters
  - options: any
  Returns NamespacePrivate

Const RESPONSE_DIAGNOSTICS_MASK_ALL

RESPONSE_DIAGNOSTICS_MASK_ALL: 1023 = 1023

Const _enumerationBrowseDirection

_enumerationBrowseDirection: Enum

Const _enumerationDataType

_enumerationDataType: Enum

Const _enumerationMessageSecurityMode

_enumerationMessageSecurityMode: Enum

Const _enumerationResultMask

_enumerationResultMask: Enum

Const _enumerationTimestampsToReturn

_enumerationTimestampsToReturn: Enum

Const allPermissions

allPermissions: number

Const attributeNameById

attributeNameById: {}

Type declaration

[key: string]: string | number

Const crypto_utils

crypto_utils: typeof crypto_util1

Const defaultCloneExtraInfo

defaultCloneExtraInfo: CloneExtraInfo

Const defaultCloneFilter

defaultCloneFilter: CloneFilter

Const emptyGuid

emptyGuid: "00000000-0000-0000-0000-000000000000" = "00000000-0000-0000-0000-000000000000"

Const extraStatusCodeBits

extraStatusCodeBits: {}

StatusCode Special bits

Type declaration

[key: string]: number

Const minOPCUADate

minOPCUADate: Date

Const nodesets

nodesets: { adi: string; autoId: string; cnc: string; commercialKitchenEquipment: string; di: string; eumabois: string; gds: string; glass: string; ia: string; machineTool: string; machineVision: string; machinery: string; packML: string; robotics: string; standard: string; woodWorking: string }

Type declaration

adi: string
autoId: string
cnc: string
commercialKitchenEquipment: string
di: string
eumabois: string
gds: string
glass: string
ia: string
machineTool: string
machineVision: string
machinery: string
packML: string
robotics: string
standard: string
woodWorking: string

Const offsetFactor1601

offsetFactor1601: number[]

Const periodicClockAdjustment

periodicClockAdjustment: { adjustmentCount: number; interval: number; timerInstallationCount: number }

Type declaration

adjustmentCount: number
interval: number
timerInstallationCount: number

Const requestHandleNotSetValue

requestHandleNotSetValue: 3735928559 = 3735928559

Const schemaBrowseDirection

schemaBrowseDirection: { enumValues: typeof BrowseDirection; name: string }

Type declaration

enumValues: typeof BrowseDirection
name: string

Const schemaDiagnosticInfo

schemaDiagnosticInfo: StructuredTypeSchema

Const schemaEnumNodeClass

schemaEnumNodeClass: { documentation: string; enumValues: typeof NodeClass; name: string }

Type declaration

documentation: string
enumValues: typeof NodeClass
name: string

Const schemaQualifiedName

schemaQualifiedName: StructuredTypeSchema

Const schemaResultMask

schemaResultMask: { enumValues: typeof ResultMask; name: string }

Type declaration

enumValues: typeof ResultMask
name: string

Const schemaSessionAuthenticationToken

schemaSessionAuthenticationToken: { name: string; subType: string }

Type declaration

name: string
subType: string

Const schemaTimestampsToReturn

schemaTimestampsToReturn: { enumValues: typeof TimestampsToReturn; name: string }

Type declaration

enumValues: typeof TimestampsToReturn
name: string

Const serverCapabilities

serverCapabilities: string[]

Const standardUnits

standardUnits: StandardUnits

Const utils

utils: typeof utils1

Functions

__checkWhereClause

__checkWhereClause(addressSpace: IAddressSpace, sessionContext: ISessionContext, whereClause: ContentFilter, index: number, eventData: IEventData): boolean

- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/check_where_clause.d.ts:3
Parameters
- addressSpace: IAddressSpace
- sessionContext: ISessionContext
- whereClause: ContentFilter
- index: number
- eventData: IEventData
Returns boolean

_accessLevelFlagToString

_accessLevelFlagToString(accessLevelFlag: number): string[]

- Defined in node-opcua-data-model/dist/access_level.d.ts:21
Parameters
- accessLevelFlag: number
Returns string[]

_announceServerOnMulticastSubnet

_announceServerOnMulticastSubnet(multicastDNS: bonjour.Bonjour, options: Announcement): Promise<bonjour.Service>

- Defined in node-opcua-service-discovery/dist/bonjour.d.ts:11
Parameters
- multicastDNS: bonjour.Bonjour
- options: Announcement
Returns Promise<bonjour.Service>

_findGoodDataValueAfter

_findGoodDataValueAfter(dataValues: DataValue[], index: number, bTreatUncertainAsBad: boolean): DataValueWithIndex

- Defined in node-opcua-aggregates/dist/interval.d.ts:26
Parameters
- dataValues: DataValue[]
- index: number
- bTreatUncertainAsBad: boolean
Returns DataValueWithIndex

_findGoodDataValueBefore

_findGoodDataValueBefore(dataValues: DataValue[], index: number, bTreatUncertainAsBad: boolean): DataValueWithIndex

- Defined in node-opcua-aggregates/dist/interval.d.ts:25
Parameters
- dataValues: DataValue[]
- index: number
- bTreatUncertainAsBad: boolean
Returns DataValueWithIndex

accessLevelExFlagToString

accessLevelExFlagToString(accessLevelFlag: AccessLevelExFlag): string

- Defined in node-opcua-data-model/dist/access_level_ex.d.ts:32
Parameters
- accessLevelFlag: AccessLevelExFlag
Returns string

accessLevelFlagToString

accessLevelFlagToString(accessLevelFlag: AccessLevelFlag): string

- Defined in node-opcua-data-model/dist/access_level.d.ts:22
Parameters
- accessLevelFlag: AccessLevelFlag
Returns string

accessRestrictionsFlagToString

accessRestrictionsFlagToString(flags: AccessRestrictionsFlag): string

- Defined in node-opcua-data-model/dist/access_restrictions.d.ts:9
Parameters
- flags: AccessRestrictionsFlag
Returns string

acknowledgeCondition

acknowledgeCondition(session: ClientSession, eventStuff: EventStuff, comment: string): Promise<StatusCode>

- Defined in node-opcua-client/dist/alarms_and_conditions/client_alarm_tools_acknowledge_all_conditions.d.ts:10
Parameters
- session: ClientSession
- eventStuff: EventStuff
- comment: string
Returns Promise<StatusCode>

acknwoledgeAllConditions

acknwoledgeAllConditions(session: ClientSession, message: string): Promise<void>

- Defined in node-opcua-client/dist/alarms_and_conditions/client_alarm_tools_acknowledge_all_conditions.d.ts:17
Parameters
- session: ClientSession
- message: string
Returns Promise<void>

acquireBonjour

acquireBonjour(): bonjour.Bonjour

- Defined in node-opcua-service-discovery/dist/bonjour.d.ts:2
Returns bonjour.Bonjour

addAggregateSupport

addAggregateSupport(addressSpace: AddressSpace): void

- Defined in node-opcua-aggregates/dist/aggregates.d.ts:5
Parameters
- addressSpace: AddressSpace
Returns void

addElement

addElement<T>(options: any, uaArrayVariableNode: UADynamicVariableArray<T>): UAVariable

- Defined in node-opcua-address-space/source/address_space_ts.ts:197
Type parameters
- T: ExtensionObject<T>
Parameters
- options: any
- uaArrayVariableNode: UADynamicVariableArray<T>
Returns UAVariable

adjustBrowseDirection

adjustBrowseDirection(browseDirection: BrowseDirection | null | undefined, defaultValue: BrowseDirection): BrowseDirection

- Defined in node-opcua-address-space/dist/source/helpers/adjust_browse_direction.d.ts:5
Parameters
- browseDirection: BrowseDirection | null | undefined
- defaultValue: BrowseDirection
Returns BrowseDirection

adjustNamespaceArray

adjustNamespaceArray(addressSpace: IAddressSpace): void

- Defined in node-opcua-address-space/source/address_space_ts.ts:211
Parameters
- addressSpace: IAddressSpace
Returns void

adjustProcessingOptions

adjustProcessingOptions(options: AggregateConfigurationOptionsEx | null): AggregateConfigurationOptionsEx

- Defined in node-opcua-aggregates/dist/interval.d.ts:27
Parameters
- options: AggregateConfigurationOptionsEx | null
Returns AggregateConfigurationOptionsEx

adjustVariant

adjustVariant(variant: Variant, valueRank: number, targetDataType: DataType): Variant

- Defined in node-opcua-variant/dist/adjust_variant.d.ts:3
Parameters
- variant: Variant
- valueRank: number
- targetDataType: DataType
Returns Variant

apply_timestamps

apply_timestamps(dataValue: DataValue, timestampsToReturn: TimestampsToReturn, attributeId: AttributeIds): DataValue

- Defined in node-opcua-data-value/dist/datavalue.d.ts:45
Parameters
- dataValue: DataValue
- timestampsToReturn: TimestampsToReturn
- attributeId: AttributeIds
Returns DataValue

apply_timestamps_no_copy

apply_timestamps_no_copy(dataValue: DataValue, timestampsToReturn: TimestampsToReturn, attributeId: AttributeIds, now?: PreciseClock): DataValue

- Defined in node-opcua-data-value/dist/datavalue.d.ts:46
Parameters
- dataValue: DataValue
- timestampsToReturn: TimestampsToReturn
- attributeId: AttributeIds
- Optional now: PreciseClock
Returns DataValue

assert

assert(cond: boolean | unknown | null | undefined | func, message?: string): void

- Defined in node-opcua-assert/dist/index.d.ts:2
Parameters
- cond: boolean | unknown | null | undefined | func
- Optional message: string
Returns void

asymmetricVerifyChunk

asymmetricVerifyChunk(self: CryptoFactory, chunk: Buffer, certificate: Certificate): boolean

- Defined in node-opcua-secure-channel/dist/source/security_policy.d.ts:85
Parameters
- self: CryptoFactory
- chunk: Buffer
- certificate: Certificate
Returns boolean

binaryStoreSize_ArgumentList

binaryStoreSize_ArgumentList(description: ArgumentDef[], args: any[]): number

- Defined in node-opcua-address-space/dist/source/helpers/argument_list.d.ts:14
Parameters
- description: ArgumentDef[]
- args: any[]
Returns number

bindExtObjArrayNode

bindExtObjArrayNode<T>(uaArrayVariableNode: UADynamicVariableArray<T>, variableTypeNodeId: string | NodeId, indexPropertyName: string): UAVariable

- Defined in node-opcua-address-space/source/address_space_ts.ts:191
Type parameters
- T: ExtensionObject<T>
Parameters
- uaArrayVariableNode: UADynamicVariableArray<T>
- variableTypeNodeId: string | NodeId
- indexPropertyName: string
Returns UAVariable

bn_dateToHundredNanoSecondFrom1601

bn_dateToHundredNanoSecondFrom1601(date: Date, picoseconds: number): any

- Defined in node-opcua-date-time/dist/date_time.d.ts:13
Parameters
- date: Date
- picoseconds: number
  
  : represent the portion of the date that cannot be managed by the javascript Date object
Returns any

bn_dateToHundredNanoSecondFrom1601Excess

bn_dateToHundredNanoSecondFrom1601Excess(date: Date, picoseconds: number): number

- Defined in node-opcua-date-time/dist/date_time.d.ts:14
Parameters
- date: Date
- picoseconds: number
Returns number

bn_hundredNanoSecondFrom1601ToDate

bn_hundredNanoSecondFrom1601ToDate(high: number, low: number, picoseconds?: number, _value?: Date | null): DateWithPicoseconds

- Defined in node-opcua-date-time/dist/date_time.d.ts:15
Parameters
- high: number
- low: number
- Optional picoseconds: number
- Optional _value: Date | null
Returns DateWithPicoseconds

browseAll

browseAll(session: IBasicSession, nodeToBrowse: BrowseDescriptionLike): Promise<BrowseResult>
browseAll(session: IBasicSession, nodesToBrowse: BrowseDescriptionLike[]): Promise<BrowseResult[]>

- Defined in node-opcua-pseudo-session/dist/browse_all.d.ts:6
Parameters
- session: IBasicSession
- nodeToBrowse: BrowseDescriptionLike
Returns Promise<BrowseResult>
- Defined in node-opcua-pseudo-session/dist/browse_all.d.ts:7
Parameters
- session: IBasicSession
- nodesToBrowse: BrowseDescriptionLike[]
Returns Promise<BrowseResult[]>

buffer_ellipsis

buffer_ellipsis(buffer: Buffer, start?: number, end?: number): string

- Defined in node-opcua-utils/dist/buffer_ellipsis.d.ts:5
Parameters
- buffer: Buffer
- Optional start: number
- Optional end: number
Returns string

buildVariantArray

buildVariantArray(dataType: DataType, nbElements: number, defaultValue: unknown): Float32Array | Float64Array | Uint32Array | Int32Array | Uint16Array | Int16Array | Uint8Array | Int8Array | unknown[]

- Defined in node-opcua-variant/dist/variant.d.ts:62
Parameters
- dataType: DataType
- nbElements: number
- defaultValue: unknown
Returns Float32Array | Float64Array | Uint32Array | Int32Array | Uint16Array | Int16Array | Uint8Array | Int8Array | unknown[]

build_address_space_for_conformance_testing

build_address_space_for_conformance_testing(addressSpace: AddressSpace, options: any): void

- Defined in node-opcua-address-space-for-conformance-testing/dist/address_space_for_conformance_testing.d.ts:7
Parameters
- addressSpace: AddressSpace
- options: any
Returns void

build_retrieveInputArgumentsDefinition

build_retrieveInputArgumentsDefinition(addressSpace: IAddressSpace): (objectId: NodeId, methodId: NodeId) => Argument[]

- Defined in node-opcua-address-space/dist/source/helpers/argument_list.d.ts:30
Parameters
- addressSpace: IAddressSpace
Returns (objectId: NodeId, methodId: NodeId) => Argument[]
- - (objectId: NodeId, methodId: NodeId): Argument[]
  - Parameters
    - objectId: NodeId
    - methodId: NodeId
    Returns Argument[]

calculateIntervalMaxValue

calculateIntervalMaxValue(interval: Interval, options: AggregateConfigurationOptions): DataValue

- Defined in node-opcua-aggregates/dist/minmax.d.ts:8
Parameters
- interval: Interval
- options: AggregateConfigurationOptions
Returns DataValue

calculateIntervalMinValue

calculateIntervalMinValue(interval: Interval, options: AggregateConfigurationOptions): DataValue

- Defined in node-opcua-aggregates/dist/minmax.d.ts:7
Parameters
- interval: Interval
- options: AggregateConfigurationOptions
Returns DataValue

callConditionRefresh

callConditionRefresh(subscription: ClientSubscription): Promise<void>
callConditionRefresh(subscription: ClientSubscription, callback: ErrorCallback): void

- Defined in node-opcua-client/dist/alarms_and_conditions/client_tools.d.ts:6
Parameters
- subscription: ClientSubscription
Returns Promise<void>
- Defined in node-opcua-client/dist/alarms_and_conditions/client_tools.d.ts:7
Parameters
- subscription: ClientSubscription
- callback: ErrorCallback
Returns void

callMethodHelper

callMethodHelper(context: ISessionContext, addressSpace: IAddressSpace, callMethodRequest: CallMethodRequest, callback: ResponseCallback<CallMethodResultOptions>): void

- Defined in node-opcua-address-space/dist/source/helpers/call_helpers.d.ts:5
Parameters
- context: ISessionContext
- addressSpace: IAddressSpace
- callMethodRequest: CallMethodRequest
- callback: ResponseCallback<CallMethodResultOptions>
Returns void

capitalizeFirstLetter

capitalizeFirstLetter(str: string): string

- Defined in node-opcua-utils/dist/string_utils.d.ts:4
Parameters
- str: string
Returns string

checkSelectClause

checkSelectClause(parentNode: BaseNode, selectClause: SimpleAttributeOperand): StatusCode

- Defined in node-opcua-address-space/dist/source/helpers/check_event_clause.d.ts:10
method

checkSelectClause

Parameters
- parentNode: BaseNode
- selectClause: SimpleAttributeOperand
Returns StatusCode

checkSelectClauses

checkSelectClauses(eventTypeNode: UAObjectType, selectClauses: SimpleAttributeOperand[]): StatusCode[]

- Defined in node-opcua-address-space/dist/source/helpers/check_event_clause.d.ts:17
method

checkSelectClauses

Parameters
- eventTypeNode: UAObjectType
- selectClauses: SimpleAttributeOperand[]
Returns StatusCode[]

an array of StatusCode

checkWhereClause

checkWhereClause(addressSpace: IAddressSpace, sessionContext: ISessionContext, whereClause: ContentFilter, eventData: IEventData): boolean

- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/check_where_clause.d.ts:4
Parameters
- addressSpace: IAddressSpace
- sessionContext: ISessionContext
- whereClause: ContentFilter
- eventData: IEventData
Returns boolean

check_flag

check_flag(value: number, mask: number | { value: number }): boolean

- Defined in node-opcua-utils/dist/index.d.ts:12
check if a set of bits are set in the values

method

check_flag

Parameters
- value: number
- mask: number | { value: number }
Returns boolean

chooseSecurityHeader

chooseSecurityHeader(msgType: string): SecurityHeader

- Defined in node-opcua-secure-channel/dist/source/secure_message_chunk_manager.d.ts:10
Parameters
- msgType: string
Returns SecurityHeader

Const coerceAccessLevelFlag

coerceAccessLevelFlag(str: string | number | null): AccessLevelFlag

- Defined in node-opcua-data-model/dist/access_level.d.ts:19
Parameters
- str: string | number | null
Returns AccessLevelFlag

coerceBoolean

coerceBoolean(value: string): boolean

- Defined in node-opcua-basic-types/dist/boolean.d.ts:6
Parameters
- value: string
Returns boolean

coerceByte

coerceByte(value: number | string | null): UInt8

- Defined in node-opcua-basic-types/dist/integers.d.ts:57
Parameters
- value: number | string | null
Returns UInt8

coerceByteString

coerceByteString(value: number[] | string | ByteString): ByteString

- Defined in node-opcua-basic-types/dist/byte_string.d.ts:11
Parameters
- value: number[] | string | ByteString
Returns ByteString

coerceClock

coerceClock(timestamp: undefined | null | DateWithPicoseconds | Date, picoseconds?: number): PreciseClock

- Defined in node-opcua-date-time/dist/date_time.d.ts:36
Parameters
- timestamp: undefined | null | DateWithPicoseconds | Date
- Optional picoseconds: number
Returns PreciseClock

coerceConnectionStrategy

coerceConnectionStrategy(options: ConnectionStrategyOptions | null): ConnectionStrategy

- Defined in node-opcua-secure-channel/dist/source/client/client_secure_channel_layer.d.ts:23
Parameters
- options: ConnectionStrategyOptions | null
Returns ConnectionStrategy

coerceDateTime

coerceDateTime(value: any): Date

- Defined in node-opcua-date-time/dist/encode_decode.d.ts:20
Parameters
- value: any
Returns Date

coerceDouble

coerceDouble(value: number | null | string): Double

- Defined in node-opcua-basic-types/dist/floats.d.ts:16
Parameters
- value: number | null | string
Returns Double

coerceExpandedNodeId

coerceExpandedNodeId(value: unknown): ExpandedNodeId

- Defined in node-opcua-nodeid/dist/expanded_nodeid.d.ts:61
Parameters
- value: unknown
Returns ExpandedNodeId

coerceFloat

coerceFloat(value: number | null | string): Float

- Defined in node-opcua-basic-types/dist/floats.d.ts:15
Parameters
- value: number | null | string
Returns Float

coerceInt16

coerceInt16(value: number | string | null): Int16

- Defined in node-opcua-basic-types/dist/integers.d.ts:60
Parameters
- value: number | string | null
Returns Int16

coerceInt32

coerceInt32(value: null | Int64 | UInt64 | number | string): Int32

- Defined in node-opcua-basic-types/dist/integers.d.ts:65
Parameters
- value: null | Int64 | UInt64 | number | string
Returns Int32

Const coerceInt64

coerceInt64(value: number | UInt64 | Int32 | string | null): UInt64

- Defined in node-opcua-basic-types/dist/integers.d.ts:51
Parameters
- value: number | UInt64 | Int32 | string | null
Returns UInt64

coerceInt8

coerceInt8(value: number | string | null): Int8

- Defined in node-opcua-basic-types/dist/integers.d.ts:55
Parameters
- value: number | string | null
Returns Int8

coerceLocalizedText

coerceLocalizedText(value?: null | string | LocalizedTextOptions): LocalizedText | null

- Defined in node-opcua-data-model/dist/localized_text.d.ts:4
Parameters
- Optional value: null | string | LocalizedTextOptions
Returns LocalizedText | null

coerceMessageSecurityMode

coerceMessageSecurityMode(value?: number | string): MessageSecurityMode

- Defined in node-opcua-service-secure-channel/dist/message_security_mode.d.ts:5
Parameters
- Optional value: number | string
Returns MessageSecurityMode

coerceNodeId

coerceNodeId(value: unknown, namespace?: number): NodeId

- Defined in node-opcua-nodeid/dist/nodeid.d.ts:102
Convert a value into a nodeId:
method

coerceNodeId

static

description:
- if nodeId is a string of form : "i=1234" => nodeId({value=1234, identifierType: NodeIdType.NUMERIC})
- if nodeId is a string of form : "s=foo" => nodeId({value="foo", identifierType: NodeIdType.STRING})
- if nodeId is a NodeId : coerceNodeId returns value
Parameters
- value: unknown
- Optional namespace: number
Returns NodeId

coerceQualifiedName

coerceQualifiedName(value: null): null
coerceQualifiedName(value: QualifiedNameLike): QualifiedName
coerceQualifiedName(value: string): QualifiedName

- Defined in node-opcua-data-model/dist/qualified_name.d.ts:41
Parameters
- value: null
Returns null
- Defined in node-opcua-data-model/dist/qualified_name.d.ts:42
Parameters
- value: QualifiedNameLike
Returns QualifiedName
- Defined in node-opcua-data-model/dist/qualified_name.d.ts:43
Parameters
- value: string
Returns QualifiedName

coerceSByte

coerceSByte(value: number | string | null): Int8

- Defined in node-opcua-basic-types/dist/integers.d.ts:58
Parameters
- value: number | string | null
Returns Int8

coerceSecurityPolicy

coerceSecurityPolicy(value?: string | SecurityPolicy | null): SecurityPolicy

- Defined in node-opcua-secure-channel/dist/source/security_policy.d.ts:84
Parameters
- Optional value: string | SecurityPolicy | null
Returns SecurityPolicy

coerceStatusCode

coerceStatusCode(statusCode: StatusCode | number | string | { value: number }): StatusCode

- Defined in node-opcua-status-code/dist/opcua_status_code.d.ts:89
Parameters
- statusCode: StatusCode | number | string | { value: number }
Returns StatusCode

coerceTimestampsToReturn

coerceTimestampsToReturn(value: number | null | undefined): TimestampsToReturn

- Defined in node-opcua-data-value/dist/TimestampsToReturn_enum.d.ts:19
Parameters
- value: number | null | undefined
Returns TimestampsToReturn

coerceUInt16

coerceUInt16(value: number | string | null): UInt16

- Defined in node-opcua-basic-types/dist/integers.d.ts:59
Parameters
- value: number | string | null
Returns UInt16

coerceUInt32

coerceUInt32(value: null | string | number | EnumItemLike): UInt32

- Defined in node-opcua-basic-types/dist/integers.d.ts:64
Parameters
- value: null | string | number | EnumItemLike
Returns UInt32

coerceUInt64

coerceUInt64(value: number | UInt64 | Int32 | string | null): UInt64

- Defined in node-opcua-basic-types/dist/integers.d.ts:49
Parameters
- value: number | UInt64 | Int32 | string | null
Returns UInt64

coerceUInt8

coerceUInt8(value: number | string | null): UInt8

- Defined in node-opcua-basic-types/dist/integers.d.ts:56
Parameters
- value: number | string | null
Returns UInt8

coerceVariantType

coerceVariantType(dataType: DataType, value: undefined | any): any

- Defined in node-opcua-variant/dist/variant.d.ts:60
Parameters
- dataType: DataType
- value: undefined | any
Returns any

compare_buffers

compare_buffers(buf1: Buffer, buf2: Buffer, max_length?: number): void

- Defined in node-opcua-utils/dist/compare_buffers.d.ts:2
Parameters
- buf1: Buffer
- buf2: Buffer
- Optional max_length: number
Returns void

computeDerivedKeys

computeDerivedKeys(cryptoFactory: CryptoFactory, serverNonce: Nonce, clientNonce: Nonce): DerivedKeys1

- Defined in node-opcua-secure-channel/dist/source/security_policy.d.ts:91
Parameters
- cryptoFactory: CryptoFactory
- serverNonce: Nonce
- clientNonce: Nonce
Returns DerivedKeys1

computeSignature

computeSignature(senderCertificate: Buffer | null, senderNonce: Nonce | null, receiverPrivateKey: PrivateKeyPEM | null, securityPolicy: SecurityPolicy): SignatureData | undefined

- Defined in node-opcua-secure-channel/dist/source/security_policy.d.ts:117
Parameters
- senderCertificate: Buffer | null
- senderNonce: Nonce | null
- receiverPrivateKey: PrivateKeyPEM | null
- securityPolicy: SecurityPolicy
Returns SignatureData | undefined

confirmAllConditions

confirmAllConditions(session: ClientSession, message: string): Promise<void>

- Defined in node-opcua-client/dist/alarms_and_conditions/client_alarm_tools_acknowledge_all_conditions.d.ts:18
Parameters
- session: ClientSession
- message: string
Returns Promise<void>

confirmCondition

confirmCondition(session: ClientSession, eventStuff: EventStuff, comment: string): Promise<StatusCode>

- Defined in node-opcua-client/dist/alarms_and_conditions/client_alarm_tools_acknowledge_all_conditions.d.ts:11
Parameters
- session: ClientSession
- eventStuff: EventStuff
- comment: string
Returns Promise<StatusCode>

constructBrowsePathFromQualifiedName

constructBrowsePathFromQualifiedName(startingNode: { nodeId: NodeId }, targetNames: QualifiedName[] | null): BrowsePath

- Defined in node-opcua-service-translate-browse-path/dist/tools_browse_path.d.ts:11
method

constructBrowsePathFromQualifiedName

Parameters
- startingNode: { nodeId: NodeId }
  - nodeId: NodeId
- targetNames: QualifiedName[] | null
Returns BrowsePath

constructEventFilter

constructEventFilter(arrayOfNames: string[] | string, conditionTypes?: NodeId[] | NodeId): EventFilter

helper to construct event filters: construct a simple event filter

example

constructEventFilter(["SourceName","Message","ReceiveTime"]);

constructEventFilter(["SourceName",{namespaceIndex:2 , "MyData"}]);
constructEventFilter(["SourceName","2:MyData" ]);

constructEventFilter(["SourceName" ,["EnabledState","EffectiveDisplayName"] ]);
constructEventFilter(["SourceName" ,"EnabledState.EffectiveDisplayName" ]);

Parameters

arrayOfNames: string[] | string
Optional conditionTypes: NodeId[] | NodeId

Returns EventFilter

constructInt64

constructInt64(high: UInt32, low: UInt32): Int64

- Defined in node-opcua-basic-types/dist/integers.d.ts:48
Parameters
- high: UInt32
- low: UInt32
Returns Int64

convertAccessLevelFlagToByte

convertAccessLevelFlagToByte(accessLevel: AccessLevelFlag): number

- Defined in node-opcua-data-model/dist/access_level.d.ts:17
Parameters
- accessLevel: AccessLevelFlag
Returns number

convertDataTypeDefinitionToStructureTypeSchema

convertDataTypeDefinitionToStructureTypeSchema(session: IBasicSession, dataTypeNodeId: NodeId, name: string, definition: DataTypeDefinition, dataTypeFactory: DataTypeFactory, cache: {}): Promise<StructuredTypeSchema>

- Defined in node-opcua-client-dynamic-extension-object/dist/convert_data_type_definition_to_structuretype_schema.d.ts:10
Parameters
- session: IBasicSession
- dataTypeNodeId: NodeId
- name: string
- definition: DataTypeDefinition
- dataTypeFactory: DataTypeFactory
- cache: {}
  - [key: string]: CacheForFieldResolution
Returns Promise<StructuredTypeSchema>

createExtObjArrayNode

createExtObjArrayNode<T>(parentFolder: UAObject, options: any): UADynamicVariableArray<T>

- Defined in node-opcua-address-space/source/address_space_ts.ts:186
Type parameters
- T: ExtensionObject<T>
Parameters
- parentFolder: UAObject
- options: any
Returns UADynamicVariableArray<T>

decodeAccessLevelExFlag

decodeAccessLevelExFlag(stream: BinaryStream): AccessLevelExFlag

- Defined in node-opcua-data-model/dist/access_level_ex.d.ts:34
Parameters
- stream: BinaryStream
Returns AccessLevelExFlag

decodeAccessLevelFlag

decodeAccessLevelFlag(stream: BinaryStream): AccessLevelFlag

- Defined in node-opcua-data-model/dist/access_level.d.ts:23
Parameters
- stream: BinaryStream
Returns AccessLevelFlag

decodeArray

decodeArray(stream: BinaryStream, decodeElementFunc: (stream: BinaryStream) => any): any[] | null

- Defined in node-opcua-basic-types/dist/array.d.ts:16
decode an array from a BinaryStream

Parameters
- stream: BinaryStream
  
  the stream.
- decodeElementFunc: (stream: BinaryStream) => any
  
  The function to decode a single array element. This function returns the element decoded from the stream
  - - (stream: BinaryStream): any
    - Parameters
      - stream: BinaryStream
      Returns any
Returns any[] | null

an array of elements or nul

decodeBoolean

decodeBoolean(stream: BinaryStream, _value?: boolean): boolean

- Defined in node-opcua-basic-types/dist/boolean.d.ts:5
Parameters
- stream: BinaryStream
- Optional _value: boolean
Returns boolean

decodeBrowseDirection

decodeBrowseDirection(stream: BinaryStream, _value?: BrowseDirection): BrowseDirection

- Defined in node-opcua-data-model/dist/BrowseDirection.d.ts:17
Parameters
- stream: BinaryStream
- Optional _value: BrowseDirection
Returns BrowseDirection

Const decodeByte

decodeByte(stream: BinaryStream, value?: number): UInt8

- Defined in node-opcua-basic-types/dist/integers.d.ts:43
Parameters
- stream: BinaryStream
- Optional value: number
Returns UInt8

decodeByteString

decodeByteString(stream: BinaryStream, _value?: ByteString): ByteString

- Defined in node-opcua-basic-types/dist/byte_string.d.ts:10
Parameters
- stream: BinaryStream
- Optional _value: ByteString
Returns ByteString

decodeDataValue

decodeDataValue(stream: BinaryStream, dataValue?: DataValue): DataValue

- Defined in node-opcua-data-value/dist/datavalue.d.ts:11
Parameters
- stream: BinaryStream
- Optional dataValue: DataValue
Returns DataValue

decodeDateTime

decodeDateTime(stream: BinaryStream, _value?: Date | null): DateWithPicoseconds

- Defined in node-opcua-date-time/dist/encode_decode.d.ts:18
Parameters
- stream: BinaryStream
- Optional _value: Date | null
Returns DateWithPicoseconds

decodeDiagnosticInfo

decodeDiagnosticInfo(stream: BinaryStream, _value?: DiagnosticInfo | null): DiagnosticInfo

- Defined in node-opcua-data-model/dist/diagnostic_info.d.ts:68
Parameters
- stream: BinaryStream
- Optional _value: DiagnosticInfo | null
Returns DiagnosticInfo

decodeDouble

decodeDouble(stream: BinaryStream, value?: number): Double

- Defined in node-opcua-basic-types/dist/floats.d.ts:14
Parameters
- stream: BinaryStream
- Optional value: number
Returns Double

decodeExpandedNodeId

decodeExpandedNodeId(stream: BinaryStream, _nodeId?: ExpandedNodeId): ExpandedNodeId

- Defined in node-opcua-basic-types/dist/node_id.d.ts:8
Parameters
- stream: BinaryStream
- Optional _nodeId: ExpandedNodeId
Returns ExpandedNodeId

decodeFloat

decodeFloat(stream: BinaryStream, value?: number): Float

- Defined in node-opcua-basic-types/dist/floats.d.ts:9
Parameters
- stream: BinaryStream
- Optional value: number
Returns Float

decodeGuid

decodeGuid(stream: BinaryStream, value?: Guid): Guid

- Defined in node-opcua-basic-types/dist/guid.d.ts:9
Parameters
- stream: BinaryStream
- Optional value: Guid
Returns Guid

Const decodeHighAccuracyDateTime

decodeHighAccuracyDateTime(stream: BinaryStream, _value?: Date | null): DateWithPicoseconds

- Defined in node-opcua-date-time/dist/encode_decode.d.ts:19
Parameters
- stream: BinaryStream
- Optional _value: Date | null
Returns DateWithPicoseconds

decodeInt16

decodeInt16(stream: BinaryStream, value?: number): Int16

- Defined in node-opcua-basic-types/dist/integers.d.ts:19
Parameters
- stream: BinaryStream
- Optional value: number
Returns Int16

decodeInt32

decodeInt32(stream: BinaryStream, value?: number): Int32

- Defined in node-opcua-basic-types/dist/integers.d.ts:23
Parameters
- stream: BinaryStream
- Optional value: number
Returns Int32

Const decodeInt64

decodeInt64(stream: BinaryStream, value?: UInt64): UInt64

- Defined in node-opcua-basic-types/dist/integers.d.ts:54
Parameters
- stream: BinaryStream
- Optional value: UInt64
Returns UInt64

decodeInt8

decodeInt8(stream: BinaryStream, value?: number): Int8

- Defined in node-opcua-basic-types/dist/integers.d.ts:31
Parameters
- stream: BinaryStream
- Optional value: number
Returns Int8

decodeLocaleId

decodeLocaleId(stream: BinaryStream): LocaleId

- Defined in node-opcua-basic-types/dist/locale_id.d.ts:9
Parameters
- stream: BinaryStream
Returns LocaleId

decodeLocalizedText

decodeLocalizedText(stream: BinaryStream, value?: LocalizedText): LocalizedText

- Defined in node-opcua-data-model/dist/localized_text.d.ts:24
Parameters
- stream: BinaryStream
- Optional value: LocalizedText
Returns LocalizedText

decodeMessage

decodeMessage(stream: BinaryStream, classNameConstructor: ConstructorFunc): BaseUAObject

- Defined in node-opcua-transport/dist/source/tools.d.ts:9
Parameters
- stream: BinaryStream
- classNameConstructor: ConstructorFunc
Returns BaseUAObject

decodeNodeId

decodeNodeId(stream: BinaryStream, _nodeId?: NodeId): NodeId

- Defined in node-opcua-basic-types/dist/node_id.d.ts:7
Parameters
- stream: BinaryStream
- Optional _nodeId: NodeId
Returns NodeId

decodeQualifiedName

decodeQualifiedName(stream: BinaryStream, value?: QualifiedName): QualifiedName

- Defined in node-opcua-data-model/dist/qualified_name.d.ts:45
Parameters
- stream: BinaryStream
- Optional value: QualifiedName
Returns QualifiedName

Const decodeSByte

decodeSByte(stream: BinaryStream, value?: number): Int8

- Defined in node-opcua-basic-types/dist/integers.d.ts:35
Parameters
- stream: BinaryStream
- Optional value: number
Returns Int8

decodeStatusCode

decodeStatusCode(stream: BinaryStream, _value?: StatusCode): StatusCode

- Defined in node-opcua-status-code/dist/opcua_status_code.d.ts:74
Parameters
- stream: BinaryStream
- Optional _value: StatusCode
Returns StatusCode

decodeString

decodeString(stream: BinaryStream, value?: string | null): string | null

- Defined in node-opcua-basic-types/dist/string.d.ts:7
Parameters
- stream: BinaryStream
- Optional value: string | null
Returns string | null

decodeTimestampsToReturn

decodeTimestampsToReturn(stream: BinaryStream, value?: TimestampsToReturn): TimestampsToReturn

- Defined in node-opcua-data-value/dist/TimestampsToReturn_enum.d.ts:17
Parameters
- stream: BinaryStream
- Optional value: TimestampsToReturn
Returns TimestampsToReturn

Const decodeUABoolean

decodeUABoolean(stream: BinaryStream, _value?: boolean): boolean

- Defined in node-opcua-basic-types/dist/boolean.d.ts:9
Parameters
- stream: BinaryStream
- Optional _value: boolean
Returns boolean

Const decodeUAString

decodeUAString(stream: BinaryStream, value?: string | null): string | null

- Defined in node-opcua-basic-types/dist/string.d.ts:11
Parameters
- stream: BinaryStream
- Optional value: string | null
Returns string | null

decodeUInt16

decodeUInt16(stream: BinaryStream, value?: number): UInt16

- Defined in node-opcua-basic-types/dist/integers.d.ts:15
Parameters
- stream: BinaryStream
- Optional value: number
Returns UInt16

decodeUInt32

decodeUInt32(stream: BinaryStream, value?: number): UInt32

- Defined in node-opcua-basic-types/dist/integers.d.ts:27
Parameters
- stream: BinaryStream
- Optional value: number
Returns UInt32

decodeUInt64

decodeUInt64(stream: BinaryStream, value?: UInt64): UInt64

- Defined in node-opcua-basic-types/dist/integers.d.ts:47
Parameters
- stream: BinaryStream
- Optional value: UInt64
Returns UInt64

decodeUInt8

decodeUInt8(stream: BinaryStream, value?: number): UInt8

- Defined in node-opcua-basic-types/dist/integers.d.ts:39
Parameters
- stream: BinaryStream
- Optional value: number
Returns UInt8

decode_ArgumentList

decode_ArgumentList(definition: ArgumentDef[], stream: BinaryStream): any[]

- Defined in node-opcua-address-space/dist/source/helpers/argument_list.d.ts:13
Parameters
- definition: ArgumentDef[]
- stream: BinaryStream
Returns any[]

dumpBrowseDescription

dumpBrowseDescription(node: BaseNode, _browseDescription: BrowseDescriptionOptions): void

- Defined in node-opcua-address-space/dist/source/helpers/dump_tools.d.ts:7
Parameters
- node: BaseNode
- _browseDescription: BrowseDescriptionOptions
Returns void

dumpEvent

dumpEvent(session: IBasicSession, fields: string[], eventFields: Variant[]): Promise<void>

- Defined in node-opcua-client/dist/alarms_and_conditions/client_alarm_tools_dump_event.d.ts:9
Parameters
- session: IBasicSession
- fields: string[]
- eventFields: Variant[]
Returns Promise<void>

dumpReferenceDescription

dumpReferenceDescription(addressSpace: IAddressSpace, referenceDescription: ReferenceDescription): void

- Defined in node-opcua-address-space/dist/source/helpers/dump_tools.d.ts:5
Parameters
- addressSpace: IAddressSpace
- referenceDescription: ReferenceDescription
Returns void

dumpReferenceDescriptions

dumpReferenceDescriptions(addressSpace: IAddressSpace, referenceDescriptions: ReferenceDescription[]): void

- Defined in node-opcua-address-space/dist/source/helpers/dump_tools.d.ts:6
Parameters
- addressSpace: IAddressSpace
- referenceDescriptions: ReferenceDescription[]
Returns void

dumpReferences

dumpReferences(addressSpace: IAddressSpace, references: UAReference[]): void

- Defined in node-opcua-address-space/dist/source/helpers/dump_tools.d.ts:14
method

dumpReferences

static

Parameters
- addressSpace: IAddressSpace
- references: UAReference[]
Returns void

dumpToBSD

dumpToBSD(namespace: INamespace): string

- Defined in node-opcua-address-space/source/address_space_ts.ts:210
Parameters
- namespace: INamespace
Returns string

dumpXml

dumpXml(node: BaseNode, options: any): string

- Defined in node-opcua-address-space/source/address_space_ts.ts:209
Parameters
- node: BaseNode
- options: any
Returns string

encodeAccessLevelExFlag

encodeAccessLevelExFlag(value: AccessLevelExFlag, stream: OutputBinaryStream): void

- Defined in node-opcua-data-model/dist/access_level_ex.d.ts:33
Parameters
- value: AccessLevelExFlag
- stream: OutputBinaryStream
Returns void

encodeAccessLevelFlag

encodeAccessLevelFlag(value: AccessLevelFlag, stream: OutputBinaryStream): void

- Defined in node-opcua-data-model/dist/access_level.d.ts:24
Parameters
- value: AccessLevelFlag
- stream: OutputBinaryStream
Returns void

encodeArray

encodeArray(arr: any[] | null, stream: OutputBinaryStream, encodeElementFunc: (value: any, stream: OutputBinaryStream) => void): void

- Defined in node-opcua-basic-types/dist/array.d.ts:8
method

encodeArray

Parameters
- arr: any[] | null
  
  the array to encode.
- stream: OutputBinaryStream
  
  the stream.
- encodeElementFunc: (value: any, stream: OutputBinaryStream) => void
  
  The function to encode a single array element.
  - - (value: any, stream: OutputBinaryStream): void
    - Parameters
      - value: any
      - stream: OutputBinaryStream
      Returns void
Returns void

encodeBoolean

encodeBoolean(value: boolean, stream: OutputBinaryStream): void

- Defined in node-opcua-basic-types/dist/boolean.d.ts:4
Parameters
- value: boolean
- stream: OutputBinaryStream
Returns void

encodeBrowseDirection

encodeBrowseDirection(value: BrowseDirection, stream: OutputBinaryStream): void

- Defined in node-opcua-data-model/dist/BrowseDirection.d.ts:16
Parameters
- value: BrowseDirection
- stream: OutputBinaryStream
Returns void

Const encodeByte

encodeByte(value: UInt8, stream: OutputBinaryStream): void

- Defined in node-opcua-basic-types/dist/integers.d.ts:42
Parameters
- value: UInt8
- stream: OutputBinaryStream
Returns void

encodeByteString

encodeByteString(byteString: ByteString, stream: OutputBinaryStream): void

- Defined in node-opcua-basic-types/dist/byte_string.d.ts:9
Parameters
- byteString: ByteString
- stream: OutputBinaryStream
Returns void

encodeDataValue

encodeDataValue(dataValue: DataValue, stream: OutputBinaryStream): void

- Defined in node-opcua-data-value/dist/datavalue.d.ts:10
Parameters
- dataValue: DataValue
- stream: OutputBinaryStream
Returns void

encodeDateTime

encodeDateTime(date: Date | null, stream: OutputBinaryStream): void

- Defined in node-opcua-date-time/dist/encode_decode.d.ts:12
Parameters
- date: Date | null
- stream: OutputBinaryStream
Returns void

encodeDiagnosticInfo

encodeDiagnosticInfo(value: DiagnosticInfo | null, stream: OutputBinaryStream): void

- Defined in node-opcua-data-model/dist/diagnostic_info.d.ts:67
Parameters
- value: DiagnosticInfo | null
- stream: OutputBinaryStream
Returns void

encodeDouble

encodeDouble(value: Double, stream: OutputBinaryStream): void

- Defined in node-opcua-basic-types/dist/floats.d.ts:13
Parameters
- value: Double
- stream: OutputBinaryStream
Returns void

encodeExpandedNodeId

encodeExpandedNodeId(expandedNodeId: ExpandedNodeId, stream: OutputBinaryStream): void

- Defined in node-opcua-basic-types/dist/node_id.d.ts:6
Parameters
- expandedNodeId: ExpandedNodeId
- stream: OutputBinaryStream
Returns void

encodeFloat

encodeFloat(value: Float, stream: OutputBinaryStream): void

- Defined in node-opcua-basic-types/dist/floats.d.ts:8
Parameters
- value: Float
- stream: OutputBinaryStream
Returns void

encodeGuid

encodeGuid(guid: Guid, stream: OutputBinaryStream): void

- Defined in node-opcua-basic-types/dist/guid.d.ts:8
Parameters
- guid: Guid
- stream: OutputBinaryStream
Returns void

encodeHighAccuracyDateTime

encodeHighAccuracyDateTime(date: Date | null, picoseconds: number, stream: OutputBinaryStream): void

- Defined in node-opcua-date-time/dist/encode_decode.d.ts:11
Parameters
- date: Date | null
- picoseconds: number
  
  {number of picoseconds to improve javascript date... }
- stream: OutputBinaryStream
Returns void

encodeInt16

encodeInt16(value: Int16, stream: OutputBinaryStream): void

- Defined in node-opcua-basic-types/dist/integers.d.ts:18
Parameters
- value: Int16
- stream: OutputBinaryStream
Returns void

encodeInt32

encodeInt32(value: Int32, stream: OutputBinaryStream): void

- Defined in node-opcua-basic-types/dist/integers.d.ts:22
Parameters
- value: Int32
- stream: OutputBinaryStream
Returns void

Const encodeInt64

encodeInt64(value: UInt64 | number, stream: OutputBinaryStream): void

- Defined in node-opcua-basic-types/dist/integers.d.ts:53
Parameters
- value: UInt64 | number
- stream: OutputBinaryStream
Returns void

encodeInt8

encodeInt8(value: Int8, stream: OutputBinaryStream): void

- Defined in node-opcua-basic-types/dist/integers.d.ts:30
Parameters
- value: Int8
- stream: OutputBinaryStream
Returns void

encodeLocaleId

encodeLocaleId(localeId: LocaleId, stream: OutputBinaryStream): void

- Defined in node-opcua-basic-types/dist/locale_id.d.ts:8
Parameters
- localeId: LocaleId
- stream: OutputBinaryStream
Returns void

encodeLocalizedText

encodeLocalizedText(value: LocalizedText, stream: OutputBinaryStream): void

- Defined in node-opcua-data-model/dist/localized_text.d.ts:23
Parameters
- value: LocalizedText
- stream: OutputBinaryStream
Returns void

encodeNodeId

encodeNodeId(nodeId: NodeId, stream: OutputBinaryStream): void

- Defined in node-opcua-basic-types/dist/node_id.d.ts:5
Parameters
- nodeId: NodeId
- stream: OutputBinaryStream
Returns void

encodeQualifiedName

encodeQualifiedName(value: QualifiedName, stream: OutputBinaryStream): void

- Defined in node-opcua-data-model/dist/qualified_name.d.ts:44
Parameters
- value: QualifiedName
- stream: OutputBinaryStream
Returns void

Const encodeSByte

encodeSByte(value: Int8, stream: OutputBinaryStream): void

- Defined in node-opcua-basic-types/dist/integers.d.ts:34
Parameters
- value: Int8
- stream: OutputBinaryStream
Returns void

encodeStatusCode

encodeStatusCode(statusCode: StatusCode | ConstantStatusCode, stream: OutputBinaryStream): void

- Defined in node-opcua-status-code/dist/opcua_status_code.d.ts:67
Parameters
- statusCode: StatusCode | ConstantStatusCode
- stream: OutputBinaryStream
Returns void

encodeString

encodeString(value: null | string, stream: OutputBinaryStream): void

- Defined in node-opcua-basic-types/dist/string.d.ts:8
Parameters
- value: null | string
- stream: OutputBinaryStream
Returns void

encodeTimestampsToReturn

encodeTimestampsToReturn(value: TimestampsToReturn, stream: OutputBinaryStream): void

- Defined in node-opcua-data-value/dist/TimestampsToReturn_enum.d.ts:16
Parameters
- value: TimestampsToReturn
- stream: OutputBinaryStream
Returns void

Const encodeUABoolean

encodeUABoolean(value: boolean, stream: OutputBinaryStream): void

- Defined in node-opcua-basic-types/dist/boolean.d.ts:8
Parameters
- value: boolean
- stream: OutputBinaryStream
Returns void

Const encodeUAString

encodeUAString(value: null | string, stream: OutputBinaryStream): void

- Defined in node-opcua-basic-types/dist/string.d.ts:12
Parameters
- value: null | string
- stream: OutputBinaryStream
Returns void

encodeUInt16

encodeUInt16(value: UInt16, stream: OutputBinaryStream): void

- Defined in node-opcua-basic-types/dist/integers.d.ts:14
Parameters
- value: UInt16
- stream: OutputBinaryStream
Returns void

encodeUInt32

encodeUInt32(value: UInt32, stream: OutputBinaryStream): void

- Defined in node-opcua-basic-types/dist/integers.d.ts:26
Parameters
- value: UInt32
- stream: OutputBinaryStream
Returns void

encodeUInt64

encodeUInt64(value: UInt64 | number, stream: OutputBinaryStream): void

- Defined in node-opcua-basic-types/dist/integers.d.ts:46
Parameters
- value: UInt64 | number
- stream: OutputBinaryStream
Returns void

encodeUInt8

encodeUInt8(value: UInt8, stream: OutputBinaryStream): void

- Defined in node-opcua-basic-types/dist/integers.d.ts:38
Parameters
- value: UInt8
- stream: OutputBinaryStream
Returns void

encode_ArgumentList

encode_ArgumentList(definition: ArgumentDef[], args: any[], stream: OutputBinaryStream): void

- Defined in node-opcua-address-space/dist/source/helpers/argument_list.d.ts:12
Parameters
- definition: ArgumentDef[]
- args: any[]
- stream: OutputBinaryStream
Returns void

ensureDatatypeExtracted

ensureDatatypeExtracted(addressSpace: IAddressSpace): Promise<ExtraDataTypeManager>

- Defined in node-opcua-address-space/dist/source/loader/ensure_datatype_extracted.d.ts:4
Parameters
- addressSpace: IAddressSpace
Returns Promise<ExtraDataTypeManager>

ensureDatatypeExtractedWithCallback

ensureDatatypeExtractedWithCallback(addressSpace: IAddressSpace, callback: CallbackT<ExtraDataTypeManager>): void

- Defined in node-opcua-address-space/dist/source/loader/ensure_datatype_extracted.d.ts:5
Parameters
- addressSpace: IAddressSpace
- callback: CallbackT<ExtraDataTypeManager>
Returns void

ensureObjectIsSecure

ensureObjectIsSecure(node: BaseNode): void

- Defined in node-opcua-address-space/dist/source/helpers/ensure_secure_access.d.ts:9
this method install the access right restriction on the given node and its children values will only be available to user with role Administrator or supervisor and with a signed and encrypted channel.

Parameters
- node: BaseNode
  
  the node which permissions are to be adjusted
Returns void

extractConditionFields

extractConditionFields(session: IBasicSession, conditionNodeId: NodeIdLike): Promise<string[]>

- Defined in node-opcua-client/dist/alarms_and_conditions/client_alarm_tools_extractConditionFields.d.ts:8
Parameters
- session: IBasicSession
- conditionNodeId: NodeIdLike
Returns Promise<string[]>

extractEventFields

extractEventFields(sessionContext: ISessionContext, selectClauses: SimpleAttributeOperand[], eventData: IEventData): Variant[]

- Defined in node-opcua-address-space/dist/src/alarms_and_conditions/extract_event_fields.d.ts:10
method

extractEventFields extract a array of eventFields from a event node, matching the selectClauses

Parameters
- sessionContext: ISessionContext
- selectClauses: SimpleAttributeOperand[]
- eventData: IEventData
  
  : a pseudo Node that provides a browse Method and a readValue(nodeId)
Returns Variant[]

extractFirstCertificateInChain

extractFirstCertificateInChain(certificateChain?: Buffer | null): Buffer | null

- Defined in node-opcua-secure-channel/dist/source/common.d.ts:17
Parameters
- Optional certificateChain: Buffer | null
Returns Buffer | null

extractFullyQualifiedDomainName

extractFullyQualifiedDomainName(): Promise<string>

- Defined in node-opcua-hostname/dist/hostname.d.ts:4
extract FullyQualifiedDomainName of this computer

Returns Promise<string>

extractRange

extractRange(dataValue: DataValue, indexRange: NumericalRange): DataValue

- Defined in node-opcua-data-value/dist/datavalue.d.ts:53
return a deep copy of the dataValue by applying indexRange if necessary on Array/Matrix

Parameters
- dataValue: DataValue
- indexRange: NumericalRange
Returns DataValue

fieldsToJson

fieldsToJson(fields: string[], eventFields: Variant[]): EventStuff

- Defined in node-opcua-client/dist/alarms_and_conditions/client_alarm.d.ts:42
Parameters
- fields: string[]
- eventFields: Variant[]
Returns EventStuff

filterDiagnosticInfo

filterDiagnosticInfo(returnDiagnostics: number, response: CallResponse): void

- Defined in node-opcua-server/dist/opcua_server.d.ts:34
Parameters
- returnDiagnostics: number
- response: CallResponse
Returns void

filterDiagnosticInfoLevel

filterDiagnosticInfoLevel(returnDiagnostics: number, diagnostic: DiagnosticInfo | null, diagnosticInfoMask: DiagnosticInfo_Mask): DiagnosticInfo | null

- Defined in node-opcua-data-model/dist/diagnostic_info.d.ts:55
Parameters
- returnDiagnostics: number
- diagnostic: DiagnosticInfo | null
- diagnosticInfoMask: DiagnosticInfo_Mask
Returns DiagnosticInfo | null

filterDiagnosticOperationLevel

filterDiagnosticOperationLevel(returnDiagnostics: number, diagnostic: DiagnosticInfo | null): DiagnosticInfo | null

- Defined in node-opcua-data-model/dist/diagnostic_info.d.ts:56
Parameters
- returnDiagnostics: number
- diagnostic: DiagnosticInfo | null
Returns DiagnosticInfo | null

filterDiagnosticServiceLevel

filterDiagnosticServiceLevel(returnDiagnostics: number, diagnostic: DiagnosticInfo | null): DiagnosticInfo | null

- Defined in node-opcua-data-model/dist/diagnostic_info.d.ts:57
Parameters
- returnDiagnostics: number
- diagnostic: DiagnosticInfo | null
Returns DiagnosticInfo | null

findActiveConditions

findActiveConditions(session: ClientSession): Promise<EventStuff[]>

- Defined in node-opcua-client/dist/alarms_and_conditions/client_alarm_tools_acknowledge_all_conditions.d.ts:16
Enumerate all events

Parameters
- session: ClientSession
Returns Promise<EventStuff[]>

findServers

findServers(discoveryServerEndpointUri: string, callback: (err: Error | null, result?: FindServerResults) => void): void
findServers(discoveryServerEndpointUri: string): Promise<FindServerResults>

- Defined in node-opcua-client/dist/tools/findservers.d.ts:14
extract the server endpoints exposed by a discovery server

method

findServers

async

Parameters
- discoveryServerEndpointUri: string
- callback: (err: Error | null, result?: FindServerResults) => void
  - - (err: Error | null, result?: FindServerResults): void
    - Parameters
      - err: Error | null
      - Optional result: FindServerResults
      Returns void
Returns void
- Defined in node-opcua-client/dist/tools/findservers.d.ts:15
Parameters
- discoveryServerEndpointUri: string
Returns Promise<FindServerResults>

findServersOnNetwork

findServersOnNetwork(discoveryServerEndpointUri: string): Promise<ServerOnNetwork[]>
findServersOnNetwork(discoveryServerEndpointUri: string, callback: (err: Error | null, servers?: ServerOnNetwork[]) => void): void

- Defined in node-opcua-client/dist/tools/findservers.d.ts:19
extract the server endpoints exposed by a discovery server

Parameters
- discoveryServerEndpointUri: string
Returns Promise<ServerOnNetwork[]>
- Defined in node-opcua-client/dist/tools/findservers.d.ts:20
Parameters
- discoveryServerEndpointUri: string
- callback: (err: Error | null, servers?: ServerOnNetwork[]) => void
  - - (err: Error | null, servers?: ServerOnNetwork[]): void
    - Parameters
      - err: Error | null
      - Optional servers: ServerOnNetwork[]
      Returns void
Returns void

fromURI

fromURI(uri: string | null): SecurityPolicy

- Defined in node-opcua-secure-channel/dist/source/security_policy.d.ts:82
Parameters
- uri: string | null
Returns SecurityPolicy

generateAddressSpace

generateAddressSpace(addressSpace: IAddressSpace, xmlFiles: string | string[], callback: (err?: Error) => void): void
generateAddressSpace(addressSpace: IAddressSpace, xmlFiles: string | string[]): Promise<void>

- Defined in node-opcua-address-space/distNodeJS/generate_address_space.d.ts:3
Parameters
- addressSpace: IAddressSpace
- xmlFiles: string | string[]
- callback: (err?: Error) => void
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void
- Defined in node-opcua-address-space/distNodeJS/generate_address_space.d.ts:4
Parameters
- addressSpace: IAddressSpace
- xmlFiles: string | string[]
Returns Promise<void>

generateAddressSpaceRaw

generateAddressSpaceRaw(addressSpace: IAddressSpace, xmlFiles: string | string[], xmlLoader: (nodeset2xmlUri: string) => Promise<string>): Promise<void>

- Defined in node-opcua-address-space/dist/source/loader/generateAddressSpaceRaw.d.ts:8
xmlfiles:

a lis of xml files

Parameters
- addressSpace: IAddressSpace
  
  the addressSpace to populate
- xmlFiles: string | string[]
- xmlLoader: (nodeset2xmlUri: string) => Promise<string>
  
  a helper function to return the content of the xml file
  - - (nodeset2xmlUri: string): Promise<string>
    - Parameters
      - nodeset2xmlUri: string
      Returns Promise<string>
Returns Promise<void>

getAggregateConfiguration

getAggregateConfiguration(node: BaseNode): AggregateConfigurationOptionsEx

- Defined in node-opcua-aggregates/dist/aggregates.d.ts:7
Parameters
- node: BaseNode
Returns AggregateConfigurationOptionsEx

getAggregateData

getAggregateData(node: UAVariable, processingInterval: number, startDate: Date, endDate: Date, lambda: (interval: Interval, aggregateConfiguration: AggregateConfigurationOptionsEx) => DataValue, callback: (err: Error | null, dataValues?: DataValue[]) => void): void

- Defined in node-opcua-aggregates/dist/common.d.ts:7
Parameters
- node: UAVariable
- processingInterval: number
- startDate: Date
- endDate: Date
- lambda: (interval: Interval, aggregateConfiguration: AggregateConfigurationOptionsEx) => DataValue
  - - (interval: Interval, aggregateConfiguration: AggregateConfigurationOptionsEx): DataValue
    - Parameters
      - interval: Interval
      - aggregateConfiguration: AggregateConfigurationOptionsEx
      Returns DataValue
- callback: (err: Error | null, dataValues?: DataValue[]) => void
  - - (err: Error | null, dataValues?: DataValue[]): void
    - Parameters
      - err: Error | null
      - Optional dataValues: DataValue[]
      Returns void
Returns void

getAverageData

getAverageData(node: UAVariable, processingInterval: number, startDate: Date, endDate: Date, callback: (err: Error | null, dataValues?: DataValue[]) => void): void

- Defined in node-opcua-aggregates/dist/average.d.ts:3
Parameters
- node: UAVariable
- processingInterval: number
- startDate: Date
- endDate: Date
- callback: (err: Error | null, dataValues?: DataValue[]) => void
  - - (err: Error | null, dataValues?: DataValue[]): void
    - Parameters
      - err: Error | null
      - Optional dataValues: DataValue[]
      Returns void
Returns void

getCryptoFactory

getCryptoFactory(securityPolicy: SecurityPolicy): CryptoFactory | null

- Defined in node-opcua-secure-channel/dist/source/security_policy.d.ts:116
Parameters
- securityPolicy: SecurityPolicy
Returns CryptoFactory | null

getCurrentClock

getCurrentClock(): PreciseClock

- Defined in node-opcua-date-time/dist/date_time.d.ts:35
Returns PreciseClock

getCurrentClockWithJavascriptDate

getCurrentClockWithJavascriptDate(): PreciseClock

- Defined in node-opcua-date-time/dist/date_time.d.ts:27
Returns PreciseClock

PreciseClock

getDefaultCertificateManager

getDefaultCertificateManager(name: "PKI" | "UserPKI"): OPCUACertificateManager

- Defined in node-opcua-certificate-manager/dist/certificate_manager.d.ts:53
Parameters
- name: "PKI" | "UserPKI"
Returns OPCUACertificateManager

getExtensionObjectConstructor

getExtensionObjectConstructor(session: IBasicSession, dataTypeNodeId: NodeId): Promise<AnyConstructorFunc>

- Defined in node-opcua-client-dynamic-extension-object/dist/get_extension_object_constructor.d.ts:7
Parameters
- session: IBasicSession
- dataTypeNodeId: NodeId
Returns Promise<AnyConstructorFunc>

getExtraDataTypeManager

getExtraDataTypeManager(session: IBasicSession): Promise<ExtraDataTypeManager>

- Defined in node-opcua-client-dynamic-extension-object/dist/get_extra_data_type_manager.d.ts:3
Parameters
- session: IBasicSession
Returns Promise<ExtraDataTypeManager>

getFakeTransport

getFakeTransport(): any

- Defined in node-opcua-transport/dist/source/tcp_transport.d.ts:15
Returns any

getFullyQualifiedDomainName

getFullyQualifiedDomainName(optional_max_length?: number): string

- Defined in node-opcua-hostname/dist/hostname.d.ts:6
Parameters
- Optional optional_max_length: number
Returns string

getFunctionParameterNames

getFunctionParameterNames(func: FunctionVariadic): string[]

- Defined in node-opcua-utils/dist/get_function_parameters_name.d.ts:2
Parameters
- func: FunctionVariadic
Returns string[]

getHostname

getHostname(): string

- Defined in node-opcua-hostname/dist/hostname.d.ts:7
Returns string

getInterpolatedData

getInterpolatedData(node: UAVariable, processingInterval: number, startDate: Date, endDate: Date, callback: (err: Error | null, dataValues?: DataValue[]) => void): void

- Defined in node-opcua-aggregates/dist/interpolate.d.ts:16
Parameters
- node: UAVariable
- processingInterval: number
- startDate: Date
- endDate: Date
- callback: (err: Error | null, dataValues?: DataValue[]) => void
  - - (err: Error | null, dataValues?: DataValue[]): void
    - Parameters
      - err: Error | null
      - Optional dataValues: DataValue[]
      Returns void
Returns void

getInterval

getInterval(startTime: Date, duration: number, indexHint: number, dataValues: DataValue[]): Interval

- Defined in node-opcua-aggregates/dist/interval.d.ts:49
Parameters
- startTime: Date
- duration: number
- indexHint: number
- dataValues: DataValue[]
Returns Interval

getMaxData

getMaxData(node: UAVariable, processingInterval: number, startDate: Date, endDate: Date, callback: (err: Error | null, dataValues?: DataValue[]) => void): void

- Defined in node-opcua-aggregates/dist/minmax.d.ts:18
Parameters
- node: UAVariable
- processingInterval: number
- startDate: Date
- endDate: Date
- callback: (err: Error | null, dataValues?: DataValue[]) => void
  - - (err: Error | null, dataValues?: DataValue[]): void
    - Parameters
      - err: Error | null
      - Optional dataValues: DataValue[]
      Returns void
Returns void

getMethodDeclaration_ArgumentList

getMethodDeclaration_ArgumentList(addressSpace: IAddressSpace, objectId: NodeId, methodId: NodeId): { methodDeclaration?: UAMethod; statusCode: StatusCode }

- Defined in node-opcua-address-space/dist/source/helpers/argument_list.d.ts:15
Parameters
- addressSpace: IAddressSpace
- objectId: NodeId
- methodId: NodeId
Returns { methodDeclaration?: UAMethod; statusCode: StatusCode }
- Optional methodDeclaration?: UAMethod
- statusCode: StatusCode

getMinData

getMinData(node: UAVariable, processingInterval: number, startDate: Date, endDate: Date, callback: (err: Error | null, dataValues?: DataValue[]) => void): void

- Defined in node-opcua-aggregates/dist/minmax.d.ts:17
Parameters
- node: UAVariable
- processingInterval: number
- startDate: Date
- endDate: Date
- callback: (err: Error | null, dataValues?: DataValue[]) => void
  - - (err: Error | null, dataValues?: DataValue[]): void
    - Parameters
      - err: Error | null
      - Optional dataValues: DataValue[]
      Returns void
Returns void

getObjectClassName

getObjectClassName(obj: unknown): string

- Defined in node-opcua-utils/dist/object_classname.d.ts:9
method

getObjectClassName

Parameters
- obj: unknown
Returns string

getOptionsForSymmetricSignAndEncrypt

getOptionsForSymmetricSignAndEncrypt(securityMode: MessageSecurityMode, derivedKeys: DerivedKeys): SecureMessageChunkManagerOptionsPartial

- Defined in node-opcua-secure-channel/dist/source/security_policy.d.ts:126
Parameters
- securityMode: MessageSecurityMode
- derivedKeys: DerivedKeys
Returns SecureMessageChunkManagerOptionsPartial

getStatusCodeFromCode

getStatusCodeFromCode(code: number): StatusCode

- Defined in node-opcua-status-code/dist/opcua_status_code.d.ts:73
returns the StatusCode corresponding to the provided value, if any

note:

if code is not known , then StatusCodes.Bad will be returned

Parameters
- code: number
Returns StatusCode

getThumbprint

getThumbprint(certificateChain: Buffer | null): Buffer | null

- Defined in node-opcua-secure-channel/dist/source/common.d.ts:18
Parameters
- certificateChain: Buffer | null
Returns Buffer | null

Let get_clock_tick

get_clock_tick(): number

- Defined in node-opcua-utils/dist/get_clock_tick.d.ts:4
Returns number

Const get_empty_nodeset_filename

get_empty_nodeset_filename(): string

- Defined in node-opcua-address-space/distHelpers/get_mini_address_space.d.ts:5
Returns string

Const get_mini_nodeset_filename

get_mini_nodeset_filename(): string

- Defined in node-opcua-address-space/distHelpers/get_mini_address_space.d.ts:4
Returns string

hasTokenExpired

hasTokenExpired(token: ChannelSecurityToken): boolean

- Defined in node-opcua-service-secure-channel/dist/index.d.ts:6
Parameters
- token: ChannelSecurityToken
Returns boolean

hexDump

hexDump(buffer: Buffer | null, width?: number, maxSize?: number): string

- Defined in node-opcua-debug/dist/hexDump.d.ts:2
Parameters
- buffer: Buffer | null
- Optional width: number
- Optional maxSize: number
Returns string

Const hrtime

hrtime(time?: [number, number]): [number, number]

- Defined in node-opcua-utils/dist/hrtime.d.ts:2
Parameters
- Optional time: [number, number]
Returns [number, number]

installAggregateConfigurationOptions

installAggregateConfigurationOptions(node: UAVariable, options: AggregateConfigurationOptionsEx): void

- Defined in node-opcua-aggregates/dist/aggregates.d.ts:6
Parameters
- node: UAVariable
- options: AggregateConfigurationOptionsEx
Returns void

installAlarmMonitoring

installAlarmMonitoring(session: ClientSession): Promise<ClientAlarmList>

- Defined in node-opcua-client/dist/alarms_and_conditions/client_alarm_tools.d.ts:4
Parameters
- session: ClientSession
Returns Promise<ClientAlarmList>

installPeriodicClockAdjustment

installPeriodicClockAdjustment(): void

- Defined in node-opcua-date-time/dist/date_time.d.ts:33
Returns void

install_optional_cpu_and_memory_usage_node

install_optional_cpu_and_memory_usage_node(server: any): void

- Defined in node-opcua-vendor-diagnostic/dist/vendor_diagnostic_nodes.d.ts:9
optionally install a CPU Usage and Memory Usage node ( condition : running on linux and require("usage")

method

install_optional_cpu_and_memory_usage_node

Parameters
- server: any
Returns void

interpolateValue

interpolateValue(dataValue1: DataValue, dataValue2: DataValue, date: Date): DataValue

- Defined in node-opcua-aggregates/dist/common.d.ts:8
Parameters
- dataValue1: DataValue
- dataValue2: DataValue
- date: Date
Returns DataValue

interpolatedValue

interpolatedValue(interval: Interval, options: AggregateConfigurationOptionsEx): DataValue

- Defined in node-opcua-aggregates/dist/interpolate.d.ts:7
Parameters
- interval: Interval
- options: AggregateConfigurationOptionsEx
Returns DataValue

isBad

isBad(statusCode: StatusCode): boolean

- Defined in node-opcua-aggregates/dist/interval.d.ts:12
Parameters
- statusCode: StatusCode
Returns boolean

isDataEncoding

isDataEncoding(dataEncoding: unknown): boolean

- Defined in node-opcua-data-model/dist/data_encoding.d.ts:5
Parameters
- dataEncoding: unknown
Returns boolean

isEmptyNonce

isEmptyNonce(nonce: Buffer): boolean

- Defined in node-opcua-secure-channel/dist/source/server/server_secure_channel_layer.d.ts:53
returns true if the nonce is null or zero (all bytes set to 0)

Parameters
- nonce: Buffer
Returns boolean

isGood

isGood(statusCode: StatusCode): boolean

- Defined in node-opcua-aggregates/dist/interval.d.ts:13
Parameters
- statusCode: StatusCode
Returns boolean

isGoodish

isGoodish(statusCode: StatusCode): boolean

- Defined in node-opcua-aggregates/dist/interval.d.ts:11
Parameters
- statusCode: StatusCode
Returns boolean

isMinDate

isMinDate(date?: Date | null): boolean

- Defined in node-opcua-date-time/dist/date_time.d.ts:38
Parameters
- Optional date: Date | null
Returns boolean

isNullOrUndefined

isNullOrUndefined(value: unknown | undefined): boolean

- Defined in node-opcua-utils/dist/index.d.ts:15
Parameters
- value: unknown | undefined
Returns boolean

isOutsideDeadbandAbsolute

isOutsideDeadbandAbsolute(variant1: Variant, variant2: Variant, deadbandValue: number): boolean

- Defined in node-opcua-service-subscription/dist/deadband_checker.d.ts:22
method

isOutsideDeadbandAbsolute

Parameters
- variant1: Variant
- variant2: Variant
- deadbandValue: number
Returns boolean

true if the element is in deadBand

isOutsideDeadbandNone

isOutsideDeadbandNone(variant1: Variant, variant2: Variant): boolean

- Defined in node-opcua-service-subscription/dist/deadband_checker.d.ts:17
method

isOutsideDeadbandNone

Parameters
- variant1: Variant
- variant2: Variant
Returns boolean

true if the element is in deadBand

isOutsideDeadbandPercent

isOutsideDeadbandPercent(variant1: Variant, variant2: Variant, deadbandValue: number, range: PseudoRange): boolean

- Defined in node-opcua-service-subscription/dist/deadband_checker.d.ts:27
method

isOutsideDeadband

Parameters
- variant1: Variant
- variant2: Variant
- deadbandValue: number
- range: PseudoRange
Returns boolean

true if the element is outside deadBand

isValidAttributeId

isValidAttributeId(attributeId: number): boolean

- Defined in node-opcua-basic-types/dist/attributeIds.d.ts:34
Parameters
- attributeId: number
Returns boolean

isValidBoolean

isValidBoolean(value: unknown): boolean

- Defined in node-opcua-basic-types/dist/boolean.d.ts:2
Parameters
- value: unknown
Returns boolean

Const isValidByte

isValidByte(value: number): boolean

- Defined in node-opcua-basic-types/dist/integers.d.ts:40
Parameters
- value: number
Returns boolean

isValidByteString

isValidByteString(value: unknown): boolean

- Defined in node-opcua-basic-types/dist/byte_string.d.ts:6
Parameters
- value: unknown
Returns boolean

isValidDataEncoding

isValidDataEncoding(dataEncoding?: string | null | QualifiedNameLike): boolean

- Defined in node-opcua-data-model/dist/data_encoding.d.ts:6
Parameters
- Optional dataEncoding: string | null | QualifiedNameLike
Returns boolean

isValidDateTime

isValidDateTime(value: any): boolean

- Defined in node-opcua-date-time/dist/encode_decode.d.ts:3
Parameters
- value: any
Returns boolean

isValidDouble

isValidDouble(value: number): boolean

- Defined in node-opcua-basic-types/dist/floats.d.ts:10
Parameters
- value: number
Returns boolean

isValidFloat

isValidFloat(value: number): boolean

- Defined in node-opcua-basic-types/dist/floats.d.ts:5
Parameters
- value: number
Returns boolean

isValidGuid

isValidGuid(guid: string): boolean

- Defined in node-opcua-guid/dist/guid.d.ts:10
checks if provided string is a valid Guid a valid GUID has the form XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX when X is a hexadecimal digit

method

isValidGuid

Parameters
- guid: string
  
  the GUID to test for validaty
Returns boolean
- true if the string is a valid GUID.

isValidInt16

isValidInt16(value: number): boolean

- Defined in node-opcua-basic-types/dist/integers.d.ts:16
Parameters
- value: number
Returns boolean

isValidInt32

isValidInt32(value: number): boolean

- Defined in node-opcua-basic-types/dist/integers.d.ts:20
Parameters
- value: number
Returns boolean

Const isValidInt64

isValidInt64(value?: number | number[]): boolean

- Defined in node-opcua-basic-types/dist/integers.d.ts:52
Parameters
- Optional value: number | number[]
Returns boolean

isValidInt8

isValidInt8(value: number): boolean

- Defined in node-opcua-basic-types/dist/integers.d.ts:28
Parameters
- value: number
Returns boolean

isValidNodeId

isValidNodeId(nodeId: NodeId): boolean

- Defined in node-opcua-basic-types/dist/node_id.d.ts:3
Parameters
- nodeId: NodeId
Returns boolean

Const isValidSByte

isValidSByte(value: number): boolean

- Defined in node-opcua-basic-types/dist/integers.d.ts:32
Parameters
- value: number
Returns boolean

isValidString

isValidString(value: unknown): boolean

- Defined in node-opcua-basic-types/dist/string.d.ts:5
Parameters
- value: unknown
Returns boolean

isValidUInt16

isValidUInt16(value: number): boolean

- Defined in node-opcua-basic-types/dist/integers.d.ts:2
Parameters
- value: number
Returns boolean

isValidUInt32

isValidUInt32(value: number): boolean

- Defined in node-opcua-basic-types/dist/integers.d.ts:24
Parameters
- value: number
Returns boolean

isValidUInt64

isValidUInt64(value?: number | number[]): boolean

- Defined in node-opcua-basic-types/dist/integers.d.ts:44
Parameters
- Optional value: number | number[]
Returns boolean

isValidUInt8

isValidUInt8(value: number): boolean

- Defined in node-opcua-basic-types/dist/integers.d.ts:36
Parameters
- value: number
Returns boolean

isValidVariant

isValidVariant(arrayType: VariantArrayType, dataType: DataType, value: unknown, dimensions?: number[] | null): boolean

- Defined in node-opcua-variant/dist/variant.d.ts:61
Parameters
- arrayType: VariantArrayType
- dataType: DataType
- value: unknown
- Optional dimensions: number[] | null
Returns boolean

is_valid_endpointUrl

is_valid_endpointUrl(endpointUrl: string): boolean

- Defined in node-opcua-transport/dist/source/tools.d.ts:12
Parameters
- endpointUrl: string
Returns boolean

lowerFirstLetter

lowerFirstLetter(str: string): string

- Defined in node-opcua-utils/dist/string_utils.d.ts:66
lowerFirstLetter convert a OPCUA Identifier to a javascript Identifier
summary
OPCUA and Javascript use two different rules to build identifiers.

OPCUA Identifier usually starts with a upper case letter and word are join together, this is known as the Pascal case, or CapitalizedWords convention. (for instance HelloWorld) But sometime, OPCUA identifiers do not follow this convention strictly and we can find various other convention being applied such as underscore between word, or addition of ACRONYMIC prefixes. On it's own, this causes great confusion and inconsistency in programming style.

Javascript uses a slightly different convention called camelCase where word are joined together and inner words starts with a capital letter whereas first word starts with a lower case letter. (for instance helloWorld)

In node-opcua we have taken the opinionated decision to consistently use camelCase convention for object properties so that all the code look nice and consistent. the lowerFirstLetter method can be used to easily convert from the OPCUA naming convention to javascript naming convention by applying the following rules.
- each ascii sequence in a identifier will be converted to lower camel case.
- when an identifier only contains upper case letter then it will be untouched. ( i.e CQDF => CQFD) (this rules helps to preserve acronyms)
- when a identifier starts with more than one UpperCase letter but still contain lowercase letter then the first Uppercase letter excluding the last one will be converted to lower case ( ie: EURange = > euRange)
- when a identifier contains several sequences delimited with underscores (_) the above rules will be applied to each of the element of the sequence ( ie: ALM_FlowOutOfTolerance => ALM_flowOutOfTolerance ( ALM=>ALM , FlowOutOfTolerance=>flowOutOfTolerance)
reference
example

HelloWorld => helloWorld XAxis => xAxis EURange => euRange DATE => DATE XYZ => XYZ AB => AB Ab => ab A => a T1ABC8 => T1ABC8 F_ABC_D => F_ABC_D ALM_Timeout => ALM_timeout SV_GasOn => SV_gasOn DI_VAL_FlowImp => DI_VAL_flowImp
Parameters
- str: string
Returns string

makeAccessLevelExFlag

makeAccessLevelExFlag(str: string | number | null): AccessLevelExFlag

- Defined in node-opcua-data-model/dist/access_level_ex.d.ts:30
Parameters
- str: string | number | null
Returns AccessLevelExFlag

makeAccessLevelFlag

makeAccessLevelFlag(str: string | number | null): AccessLevelFlag

- Defined in node-opcua-data-model/dist/access_level.d.ts:18
Parameters
- str: string | number | null
Returns AccessLevelFlag

makeAccessRestrictionsFlag

makeAccessRestrictionsFlag(str: string | number | null): AccessRestrictionsFlag

- Defined in node-opcua-data-model/dist/access_restrictions.d.ts:8
Parameters
- str: string | number | null
Returns AccessRestrictionsFlag

makeApplicationUrn

makeApplicationUrn(hostname: string, suffix: string): string

- Defined in node-opcua-common/dist/applicationurn.d.ts:1
Parameters
- hostname: string
- suffix: string
Returns string

makeAttributeEventName

makeAttributeEventName(attributeId: AttributeIds): string

- Defined in node-opcua-address-space/source/address_space_ts.ts:44
Parameters
- attributeId: AttributeIds
Returns string

makeBoiler

makeBoiler(addressSpace: AddressSpace, options: { browseName: string; organizedBy: BaseNode }): Boiler

- Defined in node-opcua-address-space/distHelpers/boiler_system.d.ts:110
Parameters
- addressSpace: AddressSpace
- options: { browseName: string; organizedBy: BaseNode }
  - browseName: string
  - organizedBy: BaseNode
Returns Boiler

makeBrowsePath

makeBrowsePath(rootNode: NodeIdLikeOrWithNodeId, relativePathBNF: string): BrowsePath

- Defined in node-opcua-service-translate-browse-path/dist/make_browse_path.d.ts:6
Parameters
- rootNode: NodeIdLikeOrWithNodeId
- relativePathBNF: string
Returns BrowsePath

makeEUInformation

makeEUInformation(symbol: string, shortName: string, longName: string): EUInformation

- Defined in node-opcua-data-access/dist/EUInformation.d.ts:7
Parameters
- symbol: string
- shortName: string
- longName: string
Returns EUInformation

makeExpandedNodeId

makeExpandedNodeId(value: unknown, namespace?: number): ExpandedNodeId

- Defined in node-opcua-nodeid/dist/expanded_nodeid.d.ts:68
method

makeExpandedNodeId

Parameters
- value: unknown
- Optional namespace: number
Returns ExpandedNodeId

makeNodeClassMask

makeNodeClassMask(str: string): NodeClassMask

- Defined in node-opcua-data-model/dist/node_class_mask.d.ts:14
Parameters
- str: string
Returns NodeClassMask

makeNodeId

makeNodeId(value: string | Buffer | number, namespace?: number): NodeId

- Defined in node-opcua-nodeid/dist/nodeid.d.ts:112
construct a node Id from a value and a namespace.

method

makeNodeId

static

Parameters
- value: string | Buffer | number
- Optional namespace: number
Returns NodeId

makeOptionalsMap

makeOptionalsMap(optionals?: string[] | null): OptionalMap

- Defined in node-opcua-address-space/dist/source/helpers/make_optionals_map.d.ts:21
Parameters
- Optional optionals: string[] | null
Returns OptionalMap

makePermissionFlag

makePermissionFlag(str: string | number | null): number

- Defined in node-opcua-data-model/dist/permission_flag.d.ts:111
Parameters
- str: string | number | null
Returns number

makeRefId

makeRefId(referenceTypeName: string): NodeId

- Defined in node-opcua-client-proxy/dist/proxy.d.ts:2
Parameters
- referenceTypeName: string
Returns NodeId

makeRelativePath

makeRelativePath(str: string, addressSpace?: any): RelativePath

- Defined in node-opcua-service-translate-browse-path/dist/make_relative_path.d.ts:15
construct a RelativePath from a string containing the relative path description. The string must comply to the OPCUA BNF for RelativePath ( see part 4 - Annexe A)
method

makeRelativePath

example:
```
 var relativePath = makeRelativePath("/Server.ServerStatus.CurrentTime");
```
Parameters
- str: string
- Optional addressSpace: any
Returns RelativePath

makeResultMask

makeResultMask(str: string): ResultMask

- Defined in node-opcua-data-model/dist/result_mask.d.ts:18
Parameters
- str: string
Returns ResultMask

makeRoles

makeRoles(roleIds: NodeIdLike[] | string | WellKnownRoles): NodeId[]

- Defined in node-opcua-address-space/dist/source/session_context.d.ts:70
Parameters
- roleIds: NodeIdLike[] | string | WellKnownRoles
Returns NodeId[]

makeSubject

makeSubject(applicationName: string, hostname: string): string

- Defined in node-opcua-certificate-manager/dist/make_subject.d.ts:1
Parameters
- applicationName: string
- hostname: string
Returns string

makeUserManager

makeUserManager(options?: UserManagerOptions): UAUserManagerBase

- Defined in node-opcua-server/dist/user_manager.d.ts:32
Parameters
- Optional options: UserManagerOptions
Returns UAUserManagerBase

matchUri

matchUri(endpointUri1: string | null, endpointUri2: string | null): boolean

- Defined in node-opcua-utils/dist/match_uri.d.ts:11
returns true if two endpoint matches the same address:

see

https://www.dnscheck.co/faq

see

https://tools.ietf.org/html/rfc4343 : Domain Name System (DNS) Case Insensitivity Clarification

Parameters
- endpointUri1: string | null
- endpointUri2: string | null
Returns boolean

messageHeaderToString

messageHeaderToString(messageChunk: Buffer): string

- Defined in node-opcua-secure-channel/dist/source/message_header_to_string.d.ts:8
convert the messageChunk header to a string

method

messageHeaderToString

Parameters
- messageChunk: Buffer
Returns string

nonceAlreadyBeenUsed

nonceAlreadyBeenUsed(nonce?: Buffer): boolean

- Defined in node-opcua-secure-channel/dist/source/server/server_secure_channel_layer.d.ts:54
Parameters
- Optional nonce: Buffer
Returns boolean

packTcpMessage

packTcpMessage(msgType: string, encodeableObject: BaseUAObject): Buffer

- Defined in node-opcua-transport/dist/source/tools.d.ts:10
Parameters
- msgType: string
- encodeableObject: BaseUAObject
Returns Buffer

parseEndpointUrl

parseEndpointUrl(endpointUrl: string): url.Url

- Defined in node-opcua-transport/dist/source/tools.d.ts:11
Parameters
- endpointUrl: string
Returns url.Url

performCertificateSanityCheck

performCertificateSanityCheck(serverOrClient: "server" | "client", certificateManager: OPCUACertificateManager, applicationUri: string): Promise<void>

- Defined in node-opcua-client/dist/verify.d.ts:5
Parameters
- serverOrClient: "server" | "client"
- certificateManager: OPCUACertificateManager
- applicationUri: string
Returns Promise<void>

permissionFlagToString

permissionFlagToString(permissionFlag: PermissionFlag): string

- Defined in node-opcua-data-model/dist/permission_flag.d.ts:112
Parameters
- permissionFlag: PermissionFlag
Returns string

populateDataTypeManager

populateDataTypeManager(session: IBasicSession, dataTypeManager: ExtraDataTypeManager, force: boolean): Promise<void>

- Defined in node-opcua-client-dynamic-extension-object/dist/populate_data_type_manager.d.ts:3
Parameters
- session: IBasicSession
- dataTypeManager: ExtraDataTypeManager
- force: boolean
Returns Promise<void>

prepareFQDN

prepareFQDN(): Promise<void>

- Defined in node-opcua-hostname/dist/hostname.d.ts:5
Returns Promise<void>

promoteOpaqueStructure

promoteOpaqueStructure(session: IBasicSession, dataValues: PseudoDataValue[]): Promise<void>

- Defined in node-opcua-client-dynamic-extension-object/dist/promote_opaque_structure.d.ts:6
Parameters
- session: IBasicSession
- dataValues: PseudoDataValue[]
Returns Promise<void>

promoteToMultiStateDiscrete

promoteToMultiStateDiscrete<T, DT>(node: UAVariable): UAMultiStateDiscreteImpl<T, DT>

- Defined in node-opcua-address-space/dist/src/data_access/ua_multistate_discrete_impl.d.ts:31
Type parameters
- T
- DT: DataType
Parameters
- node: UAVariable
Returns UAMultiStateDiscreteImpl<T, DT>

promoteToMultiStateValueDiscrete

promoteToMultiStateValueDiscrete<T, DT>(node: UAVariable): UAMultiStateValueDiscreteImpl<T, DT>

- Defined in node-opcua-address-space/dist/src/data_access/ua_multistate_value_discrete.d.ts:50
Type parameters
- T
- DT: DataType
Parameters
- node: UAVariable
Returns UAMultiStateValueDiscreteImpl<T, DT>

promoteToStateMachine

promoteToStateMachine(node: UAObject): UAStateMachineEx

- Defined in node-opcua-address-space/dist/source/interfaces/state_machine/ua_state_machine_type.d.ts:222
Parameters
- node: UAObject
Returns UAStateMachineEx

promoteToTwoStateDiscrete

promoteToTwoStateDiscrete(node: UAVariable): UATwoStateDiscreteEx

- Defined in node-opcua-address-space/dist/src/data_access/ua_two_state_discrete.d.ts:24
Parameters
- node: UAVariable
Returns UATwoStateDiscreteEx

randomAccessLevel

randomAccessLevel(): AccessLevelFlag

- Defined in node-opcua-data-model/dist/access_level.d.ts:20
Returns AccessLevelFlag

randomAccessLevelEx

randomAccessLevelEx(): AccessLevelExFlag

- Defined in node-opcua-data-model/dist/access_level_ex.d.ts:31
Returns AccessLevelExFlag

randomBoolean

randomBoolean(): boolean

- Defined in node-opcua-basic-types/dist/boolean.d.ts:3
Returns boolean

Const randomByte

randomByte(): UInt8

- Defined in node-opcua-basic-types/dist/integers.d.ts:41
Returns UInt8

randomByteString

randomByteString(value: unknown, len: number): ByteString

- Defined in node-opcua-basic-types/dist/byte_string.d.ts:8
Parameters
- value: unknown
- len: number
Returns ByteString

randomDateTime

randomDateTime(): Date

- Defined in node-opcua-date-time/dist/encode_decode.d.ts:4
Returns Date

randomDouble

randomDouble(): Double

- Defined in node-opcua-basic-types/dist/floats.d.ts:12
Returns Double

randomFloat

randomFloat(): Float

- Defined in node-opcua-basic-types/dist/floats.d.ts:7
Returns Float

randomGuid

randomGuid(): Guid

- Defined in node-opcua-basic-types/dist/guid.d.ts:7
Returns Guid

randomInt16

randomInt16(): Int16

- Defined in node-opcua-basic-types/dist/integers.d.ts:17
Returns Int16

randomInt32

randomInt32(): Int32

- Defined in node-opcua-basic-types/dist/integers.d.ts:21
Returns Int32

randomInt64

randomInt64(): Int64

- Defined in node-opcua-basic-types/dist/integers.d.ts:50
Returns Int64

randomInt8

randomInt8(): Int8

- Defined in node-opcua-basic-types/dist/integers.d.ts:29
Returns Int8

randomNodeId

randomNodeId(): NodeId

- Defined in node-opcua-basic-types/dist/node_id.d.ts:4
Returns NodeId

Const randomSByte

randomSByte(): Int8

- Defined in node-opcua-basic-types/dist/integers.d.ts:33
Returns Int8

randomString

randomString(): string

- Defined in node-opcua-basic-types/dist/string.d.ts:6
Returns string

randomUInt16

randomUInt16(): UInt16

- Defined in node-opcua-basic-types/dist/integers.d.ts:13
Returns UInt16

randomUInt32

randomUInt32(): UInt32

- Defined in node-opcua-basic-types/dist/integers.d.ts:25
Returns UInt32

randomUInt64

randomUInt64(): UInt64

- Defined in node-opcua-basic-types/dist/integers.d.ts:45
Returns UInt64

randomUInt8

randomUInt8(): UInt8

- Defined in node-opcua-basic-types/dist/integers.d.ts:37
Returns UInt8

readHistoryServerCapabilities

readHistoryServerCapabilities(session: ClientSession): Promise<HistoryServerCapabilities>
readHistoryServerCapabilities(session: ClientSession, callback: (err: Error | null, capabilities?: HistoryServerCapabilities) => void): void

- Defined in node-opcua-client/dist/tools/read_history_server_capabilities.d.ts:5
Parameters
- session: ClientSession
Returns Promise<HistoryServerCapabilities>
- Defined in node-opcua-client/dist/tools/read_history_server_capabilities.d.ts:6
Parameters
- session: ClientSession
- callback: (err: Error | null, capabilities?: HistoryServerCapabilities) => void
  - - (err: Error | null, capabilities?: HistoryServerCapabilities): void
    - Parameters
      - err: Error | null
      - Optional capabilities: HistoryServerCapabilities
      Returns void
Returns void

readNamespaceArray

readNamespaceArray(session: IBasicSession): Promise<string[]>

- Defined in node-opcua-pseudo-session/dist/basic_session_interface.d.ts:75
Parameters
- session: IBasicSession
Returns Promise<string[]>

readNodeSet2XmlFile

readNodeSet2XmlFile(xmlFile: string): Promise<string>

- Defined in node-opcua-address-space/distNodeJS/generate_address_space.d.ts:2
Parameters
- xmlFile: string
Returns Promise<string>

readProcessedDetails

readProcessedDetails(variable: UAVariable, context: ISessionContext, historyReadDetails: ReadProcessedDetails, indexRange: NumericRange | null, dataEncoding: QualifiedNameLike | null, continuationData: ContinuationData, callback: CallbackT<HistoryReadResult>): void

- Defined in node-opcua-aggregates/dist/read_processed_details.d.ts:6
Parameters
- variable: UAVariable
- context: ISessionContext
- historyReadDetails: ReadProcessedDetails
- indexRange: NumericRange | null
- dataEncoding: QualifiedNameLike | null
- continuationData: ContinuationData
- callback: CallbackT<HistoryReadResult>
Returns void

readRawMessageHeader

readRawMessageHeader(data: Buffer): PacketInfo

- Defined in node-opcua-transport/dist/source/message_builder_base.d.ts:9
Parameters
- data: Buffer
Returns PacketInfo

readUAAnalogItem

readUAAnalogItem(session: ClientSession, nodeId: NodeIdLike): Promise<AnalogDataItemSnapshot>
readUAAnalogItem(session: ClientSession, nodeId: NodeIdLike, callback: ResponseCallback<AnalogDataItemSnapshot>): void

- Defined in node-opcua-client/dist/client_utils.d.ts:20
method

readUAAnalogItem

Parameters
- session: ClientSession
- nodeId: NodeIdLike
Returns Promise<AnalogDataItemSnapshot>
- Defined in node-opcua-client/dist/client_utils.d.ts:21
Parameters
- session: ClientSession
- nodeId: NodeIdLike
- callback: ResponseCallback<AnalogDataItemSnapshot>
Returns void

referenceTypeToString

referenceTypeToString(addressSpace: IAddressSpace, referenceTypeId: NodeIdLike | null): string

- Defined in node-opcua-address-space/dist/source/helpers/dump_tools.d.ts:4
Parameters
- addressSpace: IAddressSpace
- referenceTypeId: NodeIdLike | null
Returns string

releaseBonjour

releaseBonjour(): void

- Defined in node-opcua-service-discovery/dist/bonjour.d.ts:3
Returns void

removeElement

removeElement<T>(uaArrayVariableNode: UADynamicVariableArray<T>, element: any): void

- Defined in node-opcua-address-space/source/address_space_ts.ts:202
Type parameters
- T: ExtensionObject<T>
Parameters
- uaArrayVariableNode: UADynamicVariableArray<T>
- element: any
Returns void

replaceBufferWithHexDump

replaceBufferWithHexDump(obj: Record<string, { toString: any }>): any

- Defined in node-opcua-utils/dist/replace_buffer_with_hex_dump.d.ts:4
Parameters
- obj: Record<string, { toString: any }>
Returns any

resolveDynamicExtensionObject

resolveDynamicExtensionObject(session: IBasicSession, variant: Variant, dataTypeManager: ExtraDataTypeManager): Promise<void>

- Defined in node-opcua-client-dynamic-extension-object/dist/resolve_dynamic_extension_object.d.ts:4
Parameters
- session: IBasicSession
- variant: Variant
- dataTypeManager: ExtraDataTypeManager
Returns Promise<void>

resolveFullyQualifiedDomainName

resolveFullyQualifiedDomainName(str: string): string

- Defined in node-opcua-hostname/dist/hostname.d.ts:8
Parameters
- str: string
Returns string

resolveNodeId

resolveNodeId(nodeIdOrString: NodeIdLike): NodeId

- Defined in node-opcua-nodeid/dist/nodeid.d.ts:120
method

resolveNodeId

static

Parameters
- nodeIdOrString: NodeIdLike
Returns NodeId

the nodeId

resolveOpaqueOnAddressSpace

resolveOpaqueOnAddressSpace(addressSpace: IAddressSpace, variants: (Variant | null) | (Variant | null)[]): Promise<void>

- Defined in node-opcua-address-space/dist/source/helpers/resolve_opaque_on_address_space.d.ts:3
Parameters
- addressSpace: IAddressSpace
- variants: (Variant | null) | (Variant | null)[]
Returns Promise<void>

resolveReferenceNode

resolveReferenceNode(addressSpace: MinimalistAddressSpace, reference: UAReference): BaseNode

- Defined in node-opcua-address-space/source/address_space_ts.ts:42
Parameters
- addressSpace: MinimalistAddressSpace
- reference: UAReference
Returns BaseNode

resolveReferenceType

resolveReferenceType(addressSpace: MinimalistAddressSpace, reference: UAReference): UAReferenceType

- Defined in node-opcua-address-space/source/address_space_ts.ts:40
Parameters
- addressSpace: MinimalistAddressSpace
- reference: UAReference
Returns UAReferenceType

roundToFloat2

roundToFloat2(float: number): number

- Defined in node-opcua-basic-types/dist/round_to_float.d.ts:1
Parameters
- float: number
Returns number

sameAnnouncement

sameAnnouncement(a?: Announcement, b?: Announcement): boolean

- Defined in node-opcua-service-discovery/dist/bonjour.d.ts:10
Parameters
- Optional a: Announcement
- Optional b: Announcement
Returns boolean

sameDataValue

sameDataValue(v1: DataValue, v2: DataValue, timestampsToReturn?: TimestampsToReturn): boolean

- Defined in node-opcua-data-value/dist/datavalue.d.ts:65
method

sameDataValue

Parameters
- v1: DataValue
- v2: DataValue
- Optional timestampsToReturn: TimestampsToReturn
Returns boolean

true if data values are identical

sameNodeId

sameNodeId(n1: NodeId, n2: NodeId): boolean

- Defined in node-opcua-nodeid/dist/nodeid.d.ts:121
Parameters
- n1: NodeId
- n2: NodeId
Returns boolean

sameStatusCode

sameStatusCode(statusCode1: StatusCode, statusCode2: StatusCode): boolean

- Defined in node-opcua-data-value/dist/datavalue.d.ts:57
Parameters
- statusCode1: StatusCode
- statusCode2: StatusCode
Returns boolean

sameVariant

sameVariant(v1: Variant, v2: Variant): boolean

- Defined in node-opcua-variant/dist/variant.d.ts:68
returns true if the two variant represent the same value

Parameters
- v1: Variant
  
  the first variant to compare
- v2: Variant
  
  the variant to compare with
Returns boolean

serverTimestampHasChanged

serverTimestampHasChanged(dataValue1: DataValue, dataValue2: DataValue): boolean

- Defined in node-opcua-data-value/dist/datavalue.d.ts:55
Parameters
- dataValue1: DataValue
- dataValue2: DataValue
Returns boolean

setDeprecated

setDeprecated(constructor: FunctionVariadic, methodName: string, helpString: string): void

- Defined in node-opcua-utils/dist/set_deprecated.d.ts:2
Parameters
- constructor: FunctionVariadic
- methodName: string
- helpString: string
Returns void

setFakeTransport

setFakeTransport(mockSocket: MockSocket): void

- Defined in node-opcua-transport/dist/source/tcp_transport.d.ts:14
Parameters
- mockSocket: MockSocket
Returns void

setNamespaceMetaData

setNamespaceMetaData(namespace: INamespace): void

- Defined in node-opcua-address-space/dist/source/set_namespace_meta_data.d.ts:2
Parameters
- namespace: INamespace
Returns void

set_flag

set_flag(value: number, mask: number | { value: number }): number

- Defined in node-opcua-utils/dist/index.d.ts:5
set a flag

method

set_flag

Parameters
- value: number
- mask: number | { value: number }
Returns number

simpleAttributeOperandToShortString

simpleAttributeOperandToShortString(self: SimpleAttributeOperand, addressSpace: any): string

- Defined in node-opcua-service-filter/dist/tools_event_filter.d.ts:32
method

toShortString

example:

Parameters
- self: SimpleAttributeOperand
- addressSpace: any
Returns string

sourceTimestampHasChanged

sourceTimestampHasChanged(dataValue1: DataValue, dataValue2: DataValue): boolean

- Defined in node-opcua-data-value/dist/datavalue.d.ts:54
Parameters
- dataValue1: DataValue
- dataValue2: DataValue
Returns boolean

stringToQualifiedName

stringToQualifiedName(value: string): QualifiedName

- Defined in node-opcua-data-model/dist/qualified_name.d.ts:40
method

stringToQualifiedName

example

stringToQualifiedName("Hello") => {namespaceIndex: 0, name: "Hello"} stringToQualifiedName("3:Hello") => {namespaceIndex: 3, name: "Hello"}

Parameters
- value: string
Returns QualifiedName

timestamp

timestamp(): string

- Defined in node-opcua-utils/dist/timestamp.d.ts:1
Returns string

timestampHasChanged

timestampHasChanged(dataValue1: DataValue, dataValue2: DataValue, timestampsToReturn?: TimestampsToReturn): boolean

- Defined in node-opcua-data-value/dist/datavalue.d.ts:56
Parameters
- dataValue1: DataValue
- dataValue2: DataValue
- Optional timestampsToReturn: TimestampsToReturn
Returns boolean

toURI

toURI(value: SecurityPolicy | string): string

- Defined in node-opcua-secure-channel/dist/source/security_policy.d.ts:83
Parameters
- value: SecurityPolicy | string
Returns string

uninstallAlarmMonitoring

uninstallAlarmMonitoring(session: ClientSession): Promise<void>

- Defined in node-opcua-client/dist/alarms_and_conditions/client_alarm_tools.d.ts:3
Parameters
- session: ClientSession
Returns Promise<void>

uninstallPeriodicClockAdjustment

uninstallPeriodicClockAdjustment(): void

- Defined in node-opcua-date-time/dist/date_time.d.ts:34
Returns void

validateLocaleId

validateLocaleId(value: unknown): boolean

- Defined in node-opcua-basic-types/dist/locale_id.d.ts:6
Parameters
- value: unknown
Returns boolean

verifyArguments_ArgumentList

verifyArguments_ArgumentList(addressSpace: IAddressSpace, methodInputArguments: Argument[], inputArguments?: Variant[]): { inputArgumentResults?: StatusCode[]; statusCode: StatusCode }

- Defined in node-opcua-address-space/dist/source/helpers/argument_list.d.ts:26
method

verifyArguments_ArgumentList

Parameters
- addressSpace: IAddressSpace
- methodInputArguments: Argument[]
- Optional inputArguments: Variant[]
Returns { inputArgumentResults?: StatusCode[]; statusCode: StatusCode }

statusCode,inputArgumentResults
- Optional inputArgumentResults?: StatusCode[]
- statusCode: StatusCode

verifyIsOPCUAValidCertificate

verifyIsOPCUAValidCertificate(certificate: Certificate, certificateFile: string, type: "client" | "server", applicationUri: string): void

- Defined in node-opcua-client/dist/verify.d.ts:4
Parameters
- certificate: Certificate
- certificateFile: string
- type: "client" | "server"
- applicationUri: string
Returns void

verifyRankAndDimensions

verifyRankAndDimensions(options: { arrayDimensions?: number[] | null; valueRank?: number }): void

- Defined in node-opcua-variant/dist/verify_rank_and_dimension.d.ts:10
ValueRank indicates whether the Value Attribute of the Variable can be an Array and how many dimensions
- n > 1 : the Value is an array with the specified number of dimensions.
- OneDimension (1): The value is an array with one dimension.
- OneOrMoreDimensions (0): The value is an array with one or more dimensions.
- Scalar (-1): The value is not an array.
- Any (-2): The value can be a scalar or an array with any number of dimensions.
- ScalarOrOneDimension (-3): The value can be a scalar or a one dimensional array.
Parameters
- options: { arrayDimensions?: number[] | null; valueRank?: number }
  - Optional arrayDimensions?: number[] | null
  - Optional valueRank?: number
Returns void

verifySignature

verifySignature(receiverCertificate: Buffer, receiverNonce: Buffer, signature: SignatureData, senderCertificate: Buffer, securityPolicy: SecurityPolicy): boolean

- Defined in node-opcua-secure-channel/dist/source/security_policy.d.ts:118
Parameters
- receiverCertificate: Buffer
- receiverNonce: Buffer
- signature: SignatureData
- senderCertificate: Buffer
- securityPolicy: SecurityPolicy
Returns boolean

writeTCPMessageHeader

writeTCPMessageHeader(msgType: string, chunkType: string, totalLength: number, stream: OutputBinaryStream | Buffer): void

- Defined in node-opcua-transport/dist/source/tools.d.ts:13
Parameters
- msgType: string
- chunkType: string
- totalLength: number
- stream: OutputBinaryStream | Buffer
Returns void

subscribe now with sterfive to access the online-user manual

Index

Enumerations

Classes

Interfaces

Type aliases

Events

Variables

Functions

Type aliases

AccessLevelFlagString

AccessLevelString

AddCommentEventHandler

Type declaration

Parameters

eventId: Buffer | null

comment: LocalizedText

branch: ConditionSnapshot

Returns void

AddStateVariableOptionals

AddTwoStateVariableOptionals

BindVariableOptions

BrowseDescriptionLike

Byte

ByteString

CallMethodRequestLike

Callback

Type parameters

T

Type declaration

Parameters

err: Error | null

Optional result: T

Returns void

Callback2

Type parameters

T

Type declaration

Parameters

err: Error | null

Optional result: T

Returns void

CallbackT

Type parameters

T

Type declaration

Parameters

err: Error | null

Optional result: T

Returns void

CallbackWithData

CharArray

ClientHandle

ClosingReason

ConstructorFunc

Type declaration

Parameters

Rest ...args: any[]

Returns BaseUAObject

ContinuationPoint

Counter

CreateMonitoredItemHook

Type declaration

Parameters

subscription: Subscription

monitoredItem: MonitoredItemBase

Returns Promise<StatusCode>

CreateMonitoredItemsRequestLike

CreateNodeOptions

CreateSecureChannelCallbackFunc

Type declaration

Parameters

err: Error | null

Optional secureChannel: ClientSecureChannelLayer

Returns void

CreateSubscriptionRequestLike

DataValueLike

DateTime

DeleteMonitoredItemHook

Type declaration