node-opcua-utils 2.54.0 → 2.60.0

package/source/index.ts

@@ -1,46 +1,46 @@
-/**
- * @module node-opcua-utils
- */
-// tslint:disable:no-bitwise
-import { assert } from "node-opcua-assert";
-
-/**
- * set a flag
- * @method set_flag
- */
-export function set_flag(value: number, mask: number | { value: number }): number {
-    if ((mask as any).value) {
-        mask = (mask as any).value;
-    }
-    assert(!mask.hasOwnProperty("value"));
-    assert(mask !== undefined);
-    return value | (mask as number);
-}
-/**
- * check if a set of bits are set in the values
- * @method check_flag
- */
-export function check_flag(value: number, mask: number | { value: number }): boolean {
-    if ((mask as any).value) {
-        mask = (mask as any).value;
-    }
-    assert(!mask.hasOwnProperty("value"));
-    return (value & (mask as number)) === (mask as number);
-}
-
-export function isNullOrUndefined(value: any): boolean {
-    return value === undefined || value === null;
-}
-
-export { buffer_ellipsis } from "./buffer_ellipsis";
-export { capitalizeFirstLetter, lowerFirstLetter } from "./string_utils";
-export { getObjectClassName } from "./object_classname";
-export { get_clock_tick } from "./get_clock_tick";
-export { compare_buffers } from "./compare_buffers";
-export { getFunctionParameterNames } from "./get_function_parameters_name";
-export * from "./watchdog";
-export { setDeprecated } from "./set_deprecated";
-export { replaceBufferWithHexDump } from "./replace_buffer_with_hex_dump";
-export * from "./timestamp";
-export * from "./line_file";
-export * from "./match_uri";
+/**
+ * @module node-opcua-utils
+ */
+// tslint:disable:no-bitwise
+import { assert } from "node-opcua-assert";
+
+/**
+ * set a flag
+ * @method set_flag
+ */
+export function set_flag(value: number, mask: number | { value: number }): number {
+    if ((mask as any).value) {
+        mask = (mask as any).value;
+    }
+    assert(!Object.prototype.hasOwnProperty.call(mask, "value"));
+    assert(mask !== undefined);
+    return value | (mask as number);
+}
+/**
+ * check if a set of bits are set in the values
+ * @method check_flag
+ */
+export function check_flag(value: number, mask: number | { value: number }): boolean {
+    if ((mask as any).value) {
+        mask = (mask as any).value;
+    }
+    assert(!Object.prototype.hasOwnProperty.call(mask, "value"));
+    return (value & (mask as number)) === (mask as number);
+}
+
+export function isNullOrUndefined(value: unknown | undefined): boolean {
+    return value === undefined || value === null;
+}
+
+export { buffer_ellipsis } from "./buffer_ellipsis";
+export { capitalizeFirstLetter, lowerFirstLetter } from "./string_utils";
+export { getObjectClassName } from "./object_classname";
+export { get_clock_tick } from "./get_clock_tick";
+export { compare_buffers } from "./compare_buffers";
+export { getFunctionParameterNames } from "./get_function_parameters_name";
+export * from "./watchdog";
+export { setDeprecated } from "./set_deprecated";
+export { replaceBufferWithHexDump } from "./replace_buffer_with_hex_dump";
+export * from "./timestamp";
+export * from "./line_file";
+export * from "./match_uri";

package/source/line_file.ts

@@ -1,24 +1,24 @@
-/**
- * @module node-opcua-utils
- */
-
-export class LineFile {
-    private _line: string[];
-
-    constructor() {
-        this._line = [];
-    }
-
-    public write(...arg: string[]): void {
-        let str = "";
-        // tslint:disable:prefer-for-of
-        for (let i = 0; i < arguments.length; i++) {
-            str += arguments[i];
-        }
-        this._line.push(str);
-    }
-
-    public toString(endOfLine: "\n" | "\r" = "\n"): string {
-        return this._line.join(endOfLine);
-    }
-}
+/**
+ * @module node-opcua-utils
+ */
+
+export class LineFile {
+    private _line: string[];
+
+    constructor() {
+        this._line = [];
+    }
+
+    public write(...args: string[]): void {
+        let str = "";
+        // tslint:disable:prefer-for-of
+        for (let i = 0; i < args.length; i++) {
+            str += args[i];
+        }
+        this._line.push(str);
+    }
+
+    public toString(endOfLine: "\n" | "\r" = "\n"): string {
+        return this._line.join(endOfLine);
+    }
+}

package/source/match_uri.ts

@@ -1,19 +1,19 @@
-/**
- * @module node-opcua-utils
- */
-/**
- * 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
- *
- */
-export function matchUri(endpointUri1: string | null, endpointUri2: string | null) {
-    if (endpointUri1 === null) {
-        return endpointUri2 === null;
-    }
-    if (endpointUri2 === null) {
-        return endpointUri1 === null;
-    }
-    return endpointUri1.toLowerCase() === endpointUri2.toLowerCase();
-}
+/**
+ * @module node-opcua-utils
+ */
+/**
+ * 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
+ *
+ */
+export function matchUri(endpointUri1: string | null, endpointUri2: string | null): boolean {
+    if (endpointUri1 === null) {
+        return endpointUri2 === null;
+    }
+    if (endpointUri2 === null) {
+        return endpointUri1 === null;
+    }
+    return endpointUri1.toLowerCase() === endpointUri2.toLowerCase();
+}

package/source/object_classname.ts

@@ -1,11 +1,11 @@
-/**
- * @module node-opcua-utils
- */
-/**
- * @method getObjectClassName
- * @param obj
- * @return {string}
- */
-export function getObjectClassName(obj: object): string {
-    return Object.prototype.toString.call(obj).slice(8, -1);
-}
+/**
+ * @module node-opcua-utils
+ */
+/**
+ * @method getObjectClassName
+ * @param obj
+ * @return {string}
+ */
+export function getObjectClassName(obj: unknown): string {
+    return Object.prototype.toString.call(obj).slice(8, -1);
+}

package/source/replace_buffer_with_hex_dump.ts

@@ -1,15 +1,15 @@
-/**
- * @module node-opcua-utils
- */
-export function replaceBufferWithHexDump(obj: any): any {
-    for (const p in obj) {
-        if (obj.hasOwnProperty(p)) {
-            if (obj[p] instanceof Buffer) {
-                obj[p] = "<BUFFER>" + obj[p].toString("hex") + "</BUFFER>";
-            } else if (typeof obj[p] === "object") {
-                replaceBufferWithHexDump(obj[p]);
-            }
-        }
-    }
-    return obj;
-}
+/**
+ * @module node-opcua-utils
+ */
+export function replaceBufferWithHexDump(obj: Record<string, { toString(format: string): void }>): any {
+    for (const p in obj) {
+        if (Object.prototype.hasOwnProperty.call(obj, p)) {
+            if (obj[p] instanceof Buffer) {
+                obj[p] = "<BUFFER>" + obj[p].toString("hex") + "</BUFFER>";
+            } else if (typeof obj[p] === "object") {
+                replaceBufferWithHexDump(obj[p]);
+            }
+        }
+    }
+    return obj;
+}

package/source/set_deprecated.ts

@@ -1,28 +1,29 @@
-/**
- * @module node-opcua-utils
- */
-// tslint:disable:ban-types
-import * as chalk from "chalk";
-import { assert } from "node-opcua-assert";
-
-/* istanbul ignore next */
-export function setDeprecated(constructor: Function, methodName: string, helpString: string): void {
-
-    const oldMethod = constructor.prototype[methodName];
-
-    assert(oldMethod instanceof Function,
-      "expecting a valid " + methodName + "method on class " + constructor.constructor.name);
-
-    let counter = 0;
-    constructor.prototype[methodName] = function() {
-        if (counter % 1000 === 0) {
-            // tslint:disable:no-console
-            console.log(chalk.green("Warning !"),
-              chalk.green(chalk.bold(constructor.name + "#" + methodName), " is now deprecated"));
-            console.log("         ", helpString);
-        }
-        counter++;
-        return oldMethod.apply(this, arguments);
-    };
-
-}
+/**
+ * @module node-opcua-utils
+ */
+// tslint:disable:ban-types
+import * as chalk from "chalk";
+import { assert } from "node-opcua-assert";
+
+import { FunctionVariadic } from "./function_variadic";
+
+/* istanbul ignore next */
+export function setDeprecated(constructor: FunctionVariadic, methodName: string, helpString: string): void {
+    const oldMethod = constructor.prototype[methodName];
+
+    assert(oldMethod instanceof Function, "expecting a valid " + methodName + "method on class " + constructor.constructor.name);
+
+    let counter = 0;
+    constructor.prototype[methodName] = function (...args: any[]) {
+        if (counter % 1000 === 0) {
+            // tslint:disable:no-console
+            console.log(
+                chalk.green("Warning !"),
+                chalk.green(chalk.bold(constructor.name + "#" + methodName), " is now deprecated")
+            );
+            console.log("         ", helpString);
+        }
+        counter++;
+        return oldMethod.call(this, ...args);
+    };
+}

package/source/string_utils.ts

@@ -31,16 +31,16 @@ export function countAlphaSlow(str: string): number {
 
 export function countUpperCase(str: string): number {
     let count = 0;
-    const n = str.length
-    for (let i=0; i < n ; i++) {
+    const n = str.length;
+    for (let i = 0; i < n; i++) {
         count += isUpperCaseChar(str[i]) ? 1 : 0;
     }
     return count;
 }
 export function countAlpha(str: string): number {
     let count = 0;
-    const n = str.length
-    for (let i=0; i < n ; i++) {
+    const n = str.length;
+    for (let i = 0; i < n; i++) {
         count += isAlpha(str[i]) ? 1 : 0;
     }
     return count;
@@ -54,19 +54,19 @@ export function countAlpha(str: string): number {
  *
  *  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  
+ *  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 indentifiers do not follow this convention strictly and we can find various 
- *  other convention being applied such as underscore between word, or addintion of ACRONYMED prefixes.
- *  On it's own, this causes great confusion and inconsistancy in programming style.
+ *  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.
  *
- *  Javascritpt 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. 
+ *  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 
+ *  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.
@@ -110,7 +110,7 @@ export function lowerFirstLetter(str: string): string {
         return str;
     }
 
-    if (str.match(/\_/)) {
+    if (str.match(/_/)) {
         return str.split("_").map(lowerFirstLetter).join("_");
     }
     let result = str.substr(0, 1).toLowerCase() + str.substr(1);

package/source/timestamp.ts

@@ -1,15 +1,11 @@
-function w(s: string | number, length: number): string {
-    return ("000" + s).substr(-length);
-}
-
-function t(d: Date): string {
-    return w(d.getUTCHours(), 2) + ":"
-        + w(d.getUTCMinutes(), 2) + ":"
-        + w(d.getUTCSeconds(), 2) + ":"
-        + w(d.getMilliseconds(), 3);
-}
-
-export function timestamp() {
-    return t(new Date());
-}
-
+function w(s: string | number, length: number): string {
+    return ("000" + s).substr(-length);
+}
+
+function t(d: Date): string {
+    return w(d.getUTCHours(), 2) + ":" + w(d.getUTCMinutes(), 2) + ":" + w(d.getUTCSeconds(), 2) + ":" + w(d.getMilliseconds(), 3);
+}
+
+export function timestamp(): string {
+    return t(new Date());
+}