Options
All
  • Public
  • Public/Protected
  • All
Menu

  subscribe now with sterfive to access the online-user manual

Index

References

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

References

StatusCodes

Re-exports StatusCodes

coerceExpandedNodeId

Re-exports coerceExpandedNodeId

coerceNodeId

Re-exports coerceNodeId

emptyGuid

Re-exports emptyGuid

isValidGuid

Re-exports isValidGuid

Type aliases

Byte

Byte: UInt8

ByteString

ByteString: Buffer

Callback

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

Type parameters

  • T

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

  • T

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

  • T

Type declaration

    • (err: Error | null, result?: T): void
    • Parameters

      • err: Error | null
      • Optional result: T

      Returns void

CallbackWithData

CallbackWithData: CallbackT<Buffer>

CharArray

CharArray: string

DateTime

DateTime: Date | DateWithPicoseconds | null

Double

Double: number

ErrorCallback

ErrorCallback: (err?: Error) => void

Type declaration

    • (err?: Error): void
    • Parameters

      • Optional err: Error

      Returns void

Float

Float: number

Guid

Guid: string

Int16

Int16: number

Int32

Int32: number

Int64

Int64: UInt32[]

Int8

Int8: number

LocaleId

LocaleId: UAString

SByte

SByte: Int8

StatusCodeCallback

StatusCodeCallback: CallbackT<StatusCode>

UABoolean

UABoolean: boolean

UAString

UAString: string | null

UInt16

UInt16: number

UInt32

UInt32: number

UInt64

UInt64: UInt32[]

UInt8

UInt8: number

Variables

Const attributeNameById

attributeNameById: {} = ...

Type declaration

  • [key: string]: string | number

Const extraStatusCodeBits

extraStatusCodeBits: {}

StatusCode Special bits

Type declaration

  • [key: string]: number

Const minOPCUADate

minOPCUADate: Date

Const offsetFactor1601

offsetFactor1601: number[]

Const periodicClockAdjustment

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

Type declaration

  • adjustmentCount: number
  • interval: number
  • timerInstallationCount: number

Functions

bn_dateToHundredNanoSecondFrom1601

  • bn_dateToHundredNanoSecondFrom1601(date: Date, picoseconds: number): any
  • 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
  • Parameters

    • date: Date
    • picoseconds: number

    Returns number

bn_hundredNanoSecondFrom1601ToDate

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

    • high: number
    • low: number
    • Optional picoseconds: number
    • Optional _value: Date | null

    Returns DateWithPicoseconds

coerceBoolean

  • coerceBoolean(value: string): boolean

coerceByte

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

    • value: number | string | null

    Returns UInt8

coerceByteString

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

coerceClock

  • Parameters

    Returns PreciseClock

coerceDateTime

  • coerceDateTime(value: any): Date
  • Parameters

    • value: any

    Returns Date

coerceDouble

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

coerceFloat

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

coerceInt16

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

    • value: number | string | null

    Returns Int16

coerceInt32

  • Parameters

    Returns Int32

Const coerceInt64

  • Parameters

    Returns UInt64

coerceInt8

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

    • value: number | string | null

    Returns Int8

coerceSByte

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

    • value: number | string | null

    Returns Int8

coerceStatusCode

  • Parameters

    • statusCode: any

    Returns StatusCode

coerceUInt16

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

    • value: number | string | null

    Returns UInt16

coerceUInt32

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

    • value: null | string | number | EnumItemLike

    Returns UInt32

coerceUInt64

  • Parameters

    Returns UInt64

coerceUInt8

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

    • value: number | string | null

    Returns UInt8

constructInt64

  • Parameters

    Returns number[]

decodeArray

decodeBoolean

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

Const decodeByte

  • Parameters

    Returns UInt8

decodeByteString

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

decodeDateTime

  • Parameters

    Returns DateWithPicoseconds

decodeDouble

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

decodeExpandedNodeId

decodeFloat

decodeGuid

Const decodeHighAccuracyDateTime

  • Parameters

    Returns DateWithPicoseconds

decodeInt16

  • Parameters

    Returns Int16

decodeInt32

  • Parameters

    Returns Int32

Const decodeInt64

  • Parameters

    Returns UInt64

decodeInt8

  • Parameters

    Returns Int8

decodeLocaleId

  • Parameters

    Returns LocaleId

decodeNodeId

  • Parameters

    Returns NodeId

Const decodeSByte

  • Parameters

    Returns Int8

decodeStatusCode

  • Parameters

    Returns any

decodeString

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

    Returns string | null

Const decodeUABoolean

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

Const decodeUAString

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

    Returns string | null

decodeUInt16

  • Parameters

    Returns UInt16

decodeUInt32

  • Parameters

    Returns UInt32

decodeUInt64

  • Parameters

    Returns UInt64

decodeUInt8

  • Parameters

    Returns UInt8

encodeArray

  • encodeArray(arr: any[] | null, stream: OutputBinaryStream, encodeElementFunc: (value: any, stream: OutputBinaryStream) => void): void
  • 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

Const encodeByte

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

    • value: UInt8
    • stream: OutputBinaryStream

    Returns void

encodeByteString

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

encodeDateTime

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

    • date: Date | null
    • stream: OutputBinaryStream

    Returns void

encodeDouble

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

encodeExpandedNodeId

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

    Returns void

encodeFloat

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

encodeGuid

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

encodeHighAccuracyDateTime

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

    • date: Date | null
    • picoseconds: number

      {number of picoseconds to improve javascript date... }

    • stream: OutputBinaryStream

    Returns void

encodeInt16

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

    • value: Int16
    • stream: OutputBinaryStream

    Returns void

encodeInt32

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

    • value: Int32
    • stream: OutputBinaryStream

    Returns void

Const encodeInt64

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

    • value: UInt64 | number
    • stream: OutputBinaryStream

    Returns void

encodeInt8

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

    • value: Int8
    • stream: OutputBinaryStream

    Returns void

encodeLocaleId

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

    • localeId: LocaleId
    • stream: OutputBinaryStream

    Returns void

encodeNodeId

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

    • nodeId: NodeId
    • stream: OutputBinaryStream

    Returns void

Const encodeSByte

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

    • value: Int8
    • stream: OutputBinaryStream

    Returns void

encodeStatusCode

  • Parameters

    Returns void

encodeString

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

    • value: null | string
    • stream: OutputBinaryStream

    Returns void

Const encodeUABoolean

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

Const encodeUAString

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

    • value: null | string
    • stream: OutputBinaryStream

    Returns void

encodeUInt16

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

    • value: UInt16
    • stream: OutputBinaryStream

    Returns void

encodeUInt32

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

    • value: UInt32
    • stream: OutputBinaryStream

    Returns void

encodeUInt64

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

    • value: UInt64 | number
    • stream: OutputBinaryStream

    Returns void

encodeUInt8

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

    • value: UInt8
    • stream: OutputBinaryStream

    Returns void

getCurrentClock

  • Returns PreciseClock

getCurrentClockWithJavascriptDate

  • Returns PreciseClock

    PreciseClock

getStatusCodeFromCode

  • getStatusCodeFromCode(code: number): any
  • 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 any

installPeriodicClockAdjustment

  • installPeriodicClockAdjustment(): void
  • Returns void

isMinDate

  • isMinDate(date?: Date | null): boolean
  • Parameters

    • Optional date: Date | null

    Returns boolean

isValidAttributeId

  • isValidAttributeId(attributeId: number): boolean

isValidBoolean

  • isValidBoolean(value: any): boolean

Const isValidByte

  • isValidByte(value: any): boolean
  • Parameters

    • value: any

    Returns boolean

isValidByteString

  • isValidByteString(value: any): boolean

isValidDateTime

  • isValidDateTime(value: any): boolean
  • Parameters

    • value: any

    Returns boolean

isValidDouble

  • isValidDouble(value: any): boolean

isValidFloat

  • isValidFloat(value: any): boolean

isValidInt16

  • isValidInt16(value: any): boolean
  • Parameters

    • value: any

    Returns boolean

isValidInt32

  • isValidInt32(value: any): boolean
  • Parameters

    • value: any

    Returns boolean

Const isValidInt64

  • isValidInt64(value: any): boolean
  • Parameters

    • value: any

    Returns boolean

isValidInt8

  • isValidInt8(value: any): boolean
  • Parameters

    • value: any

    Returns boolean

isValidNodeId

  • isValidNodeId(nodeId: NodeId): boolean
  • Parameters

    Returns boolean

Const isValidSByte

  • isValidSByte(value: any): boolean
  • Parameters

    • value: any

    Returns boolean

isValidString

  • isValidString(value: any): boolean
  • Parameters

    • value: any

    Returns boolean

isValidUInt16

  • isValidUInt16(value: any): boolean
  • Parameters

    • value: any

    Returns boolean

isValidUInt32

  • isValidUInt32(value: any): boolean
  • Parameters

    • value: any

    Returns boolean

isValidUInt64

  • isValidUInt64(value: any): boolean
  • Parameters

    • value: any

    Returns boolean

isValidUInt8

  • isValidUInt8(value: any): boolean
  • Parameters

    • value: any

    Returns boolean

randomBoolean

  • randomBoolean(): boolean

Const randomByte

  • Returns UInt8

randomByteString

  • randomByteString(value: any, len: number): ByteString

randomDateTime

  • randomDateTime(): Date
  • Returns Date

randomDouble

randomFloat

randomGuid

  • randomGuid(): Guid

randomInt16

  • Returns Int16

randomInt32

  • Returns Int32

randomInt64

  • Returns Int64

randomInt8

  • randomInt8(): Int8
  • Returns Int8

randomNodeId

  • Returns NodeId

Const randomSByte

  • randomSByte(): Int8
  • Returns Int8

randomString

  • randomString(): string
  • Returns string

randomUInt16

  • Returns UInt16

randomUInt32

  • Returns UInt32

randomUInt64

  • Returns UInt64

randomUInt8

  • Returns UInt8

roundToFloat2

  • roundToFloat2(float: number): number
  • Parameters

    • float: number

    Returns number

uninstallPeriodicClockAdjustment

  • uninstallPeriodicClockAdjustment(): void
  • Returns void

validateLocaleId

  • validateLocaleId(value: any): boolean
  • Parameters

    • value: any

    Returns boolean

Generated using TypeDoc