rclnodejs 0.29.0 → 0.31.0

package/README.md

@@ -45,7 +45,7 @@ npm i rclnodejs@x.y.z
 
 |                                      RCLNODEJS Version                                       |                                                             Compatible ROS 2 LTS                                                             |
 | :------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------: |
-| latest version (currently [v0.29.0](https://github.com/RobotWebTools/rclnodejs/tree/0.29.0)) | [Humble](https://github.com/RobotWebTools/rclnodejs/tree/humble-hawksbill)<br>[Jazzy](https://github.com/RobotWebTools/rclnodejs/tree/jazzy) |
+| latest version (currently [v0.31.0](https://github.com/RobotWebTools/rclnodejs/tree/0.31.0)) | [Humble](https://github.com/RobotWebTools/rclnodejs/tree/humble-hawksbill)<br>[Jazzy](https://github.com/RobotWebTools/rclnodejs/tree/jazzy) |
 
 ## Documentation
 

package/binding.gyp

@@ -10,6 +10,8 @@
   'variables': {
     'ros_version': '<!(node scripts/ros_distro.js)',
     'runtime%': 'node',
+    'ros_lib_dir': "<!(node -p \"require('./scripts/config.js').getROSLibPath()\")",
+    'ros_include_root': "<!(node -p \"require('./scripts/config.js').getROSIncludeRootPath()\")",
   },
   'targets': [
     {
@@ -28,6 +30,7 @@
       'include_dirs': [
         '.',
         "<!(node -e \"require('nan')\")",
+        '<(ros_include_root)',
       ],
       'cflags!': [
         '-fno-exceptions'
@@ -61,45 +64,11 @@
             ],
             'cflags_cc': [
               '-std=c++20'
-            ],
-            'include_dirs': 
-            [
-              "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/:/g, '/include/ ') + '/include/')\")",
-            ],
-            'library_dirs': [
-              "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/:/g, '/lib/ ') + '/lib/')\")",
-            ],
-            'conditions': [
-              [
-                'ros_version > 2105', # Humble, Rolling, ...
-                {
-                  'include_dirs': 
-                  [
-                    "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/:/g, '/include/ ') + '/include/')\")",
-                    "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/:/g, '/include/rcl/ ') + '/include/rcl')\")",
-                    "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/:/g, '/include/rcutils/ ') + '/include/rcutils/')\")",
-                    "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/:/g, '/include/rmw/ ') + '/include/rmw/')\")",
-                    "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/:/g, '/include/rcl_yaml_param_parser/ ') + '/include/rcl_yaml_param_parser/')\")",
-                    "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/:/g, '/include/rosidl_typesupport_interface/ ') + '/include/rosidl_typesupport_interface/')\")",
-                    "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/:/g, '/include/rcl_action/ ') + '/include/rcl_action/')\")",
-                    "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/:/g, '/include/action_msgs/ ') + '/include/action_msgs/')\")",
-                    "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/:/g, '/include/service_msgs/ ') + '/include/service_msgs/')\")",
-                    "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/:/g, '/include/unique_identifier_msgs/ ') + '/include/unique_identifier_msgs/')\")",
-                    "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/:/g, '/include/builtin_interfaces/ ') + '/include/builtin_interfaces/')\")",
-                    "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/:/g, '/include/rcl_lifecycle/ ') + '/include/rcl_lifecycle/')\")",
-                    "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/:/g, '/include/lifecycle_msgs/ ') + '/include/lifecycle_msgs/')\")",
-                    "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/:/g, '/include/rosidl_runtime_c/ ') + '/include/rosidl_runtime_c/')\")",
-                    "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/:/g, '/include/rosidl_dynamic_typesupport/ ') + '/include/rosidl_dynamic_typesupport/')\")",
-                    "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/:/g, '/include/type_description_interfaces/ ') + '/include/type_description_interfaces/')\")",
-                  ],
-                }
-              ],
-            ],
+            ]
           }
         ],
         [
-          'OS=="win"',
-          {
+          'OS=="win"', {
             'defines': [
               'OS_WINDOWS'
             ],
@@ -108,7 +77,6 @@
             ],
             'include_dirs': [
               './src/third_party/dlfcn-win32/',
-              "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/;/g, '/include ').replace(/\\\/g, '/') + '/include')\")",
             ],
             'msvs_settings': {
               'VCCLCompilerTool': {
@@ -116,49 +84,17 @@
               },
               'VCLinkerTool': {
                 'AdditionalDependencies': ['psapi.lib'],
-                'AdditionalLibraryDirectories': ["<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/;/g, '\\\lib ').replace(/\\\/g, '/') + '/lib')\")",],
+                'AdditionalLibraryDirectories': ['<(ros_lib_dir)'],
               }
-            },
-            'conditions': [
-              [ 
-                'ros_version > 2105', # Humble, Rolling, ... TODO - not tested due to broken setup_ros v3.3 action on windows 
-                {
-                  'include_dirs': 
-                  [
-                    "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/;/g, '/include/rcl ').replace(/\\\/g, '/') + '/include/rcl')\")",
-                    "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/;/g, '/include/rcutils ').replace(/\\\/g, '/') + '/include/rcutils')\")",
-                    "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/;/g, '/include/rmw ').replace(/\\\/g, '/') + '/include/rmw')\")",
-                    "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/;/g, '/include/rcl_yaml_param_parser ').replace(/\\\/g, '/') + '/include/rcl_yaml_param_parser')\")",
-                    "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/;/g, '/include/rosidl_runtime_c ').replace(/\\\/g, '/') + '/include/rosidl_runtime_c')\")",
-                    "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/;/g, '/include/rosidl_typesupport_interface ').replace(/\\\/g, '/') + '/include/rosidl_typesupport_interface')\")",
-                    "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/;/g, '/include/rcl_action ').replace(/\\\/g, '/') + '/include/rcl_action')\")",
-                    "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/;/g, '/include/action_msgs ').replace(/\\\/g, '/') + '/include/action_msgs')\")",
-                    "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/;/g, '/include/service_msgs ').replace(/\\\/g, '/') + '/include/service_msgs')\")",
-                    "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/;/g, '/include/unique_identifier_msgs ').replace(/\\\/g, '/') + '/include/unique_identifier_msgs')\")",
-                    "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/;/g, '/include/builtin_interfaces ').replace(/\\\/g, '/') + '/include/builtin_interfaces')\")",
-                    "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/;/g, '/include/rcl_lifecycle ').replace(/\\\/g, '/') + '/include/rcl_lifecycle')\")",
-                    "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/;/g, '/include/lifecycle_msgs ').replace(/\\\/g, '/') + '/include/lifecycle_msgs')\")",
-                    "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/;/g, '/include/rosidl_dynamic_typesupport ').replace(/\\\/g, '/') + '/include/rosidl_dynamic_typesupport')\")",
-                    "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/;/g, '/include/type_description_interfaces/ ').replace(/\\\/g, '/') + '/include/type_description_interfaces/')\")",
-                  ],
-                }
-              ]
-            ]
+            }
           }
         ],
         [
-          'OS=="mac"',
           # TODO - macos is no longer a tier-1 ROS platform and we have no binary ROS builds to test for Humble & Rolling
-          {
+          'OS=="mac"', {
             'defines': [
               'OS_MACOS'
             ],
-            'include_dirs': [
-              "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/:/g, '/include/ ') + '/include/')\")",
-            ],
-            'library_dirs': [
-                "<!@(node -e \"console.log(process.env.AMENT_PREFIX_PATH.replace(/:/g, '/lib/ ') + '/lib/')\")",
-            ],
             'xcode_settings': {
               'GCC_ENABLE_CPP_EXCEPTIONS': 'YES',
               'CLANG_CXX_LIBRARY': 'libc++',
@@ -168,8 +104,7 @@
           }
         ],
         [
-          'ros_version<=1911',
-          {
+          'ros_version <= 1911', {
             'libraries': [
               '-lrosidl_generator_c'
             ],
@@ -178,9 +113,22 @@
             ]
           }
         ],
-        ['runtime=="electron"', {
-          "defines": ["NODE_RUNTIME_ELECTRON=1"]
-        }],
+        [
+          # After Galactic, e.g., Humble, Jazzy, Rolling.
+          'ros_version > 2105', {
+            'include_dirs': [
+              "<!@(node -p \"require('./scripts/config.js').getIncludePaths().forEach(p => console.log(JSON.stringify(p)))\")"
+            ],
+            'library_dirs': [
+              '<(ros_lib_dir)',
+            ]
+          }
+        ],
+        [
+          'runtime=="electron"', {
+            "defines": ["NODE_RUNTIME_ELECTRON=1"]
+          }
+        ],
       ]
     }
   ]

package/lib/action/server.js

@@ -266,10 +266,12 @@ class ActionServer extends Entity {
     let goalHandle;
     if (accepted) {
       // Stamp time of acceptance
-      const secondsAndNanos = this._node.getClock().now().secondsAndNanoseconds;
+      const { seconds, nanoseconds } = this._node
+        .getClock()
+        .now().secondsAndNanoseconds;
       goalInfo.stamp = {
-        sec: secondsAndNanos.seconds,
-        nanosec: secondsAndNanos.nanoseconds,
+        sec: Number(seconds),
+        nanosec: Number(nanoseconds),
       };
 
       try {

package/lib/clock.js

@@ -52,8 +52,8 @@ class Clock {
    * @return {Time} Return the current time.
    */
   now() {
-    let time = rclnodejs.clockGetNow(this._handle);
-    return new Time(time.sec, time.nanosec, this._clockType);
+    const nowInNanosec = rclnodejs.clockGetNow(this._handle);
+    return new Time(0n, nowInNanosec, this._clockType);
   }
 }
 

package/lib/duration.js

@@ -15,7 +15,7 @@
 'use strict';
 
 const rclnodejs = require('bindings')('rclnodejs');
-const int64 = require('int64-napi');
+const S_TO_NS = 10n ** 9n;
 
 /**
  * @class - Class representing a Duration in ROS
@@ -24,51 +24,38 @@ const int64 = require('int64-napi');
 class Duration {
   /**
    * Create a Duration.
-   * @param {number|string} [seconds=0] - The second part of the duration.
-   * @param {number|string} [nanoseconds=0] - The nanosecond part of the duration.
+   * @param {bigint} [seconds=0] - The second part of the duration.
+   * @param {bigint} [nanoseconds=0] - The nanosecond part of the duration.
    */
-  constructor(seconds = 0, nanoseconds = 0) {
-    if (typeof seconds !== 'number' && typeof seconds !== 'string') {
+  constructor(seconds = 0n, nanoseconds = 0n) {
+    if (typeof seconds !== 'bigint') {
       throw new TypeError('Invalid argument of seconds');
     }
 
-    if (typeof nanoseconds !== 'number' && typeof nanoseconds !== 'string') {
+    if (typeof nanoseconds !== 'bigint') {
       throw new TypeError('Invalid argument of nanoseconds');
     }
 
-    let secondInt64 = int64.from(seconds);
-    let nanoInt64 = int64.from(nanoseconds);
-
-    if (typeof seconds === 'string' && seconds.startsWith('-')) {
-      secondInt64 = int64.negative(secondInt64);
-    }
-    if (typeof nanoseconds === 'string' && nanoseconds.startsWith('-')) {
-      nanoInt64 = int64.negative(nanoInt64);
+    const total = seconds * S_TO_NS + nanoseconds;
+    if (total >= 2n ** 63n) {
+      throw new RangeError(
+        'Total nanoseconds value is too large to store in C time point.'
+      );
     }
-    this._nanoseconds = secondInt64.multiply(1e9).add(nanoInt64);
-    this._handle = rclnodejs.createDuration(this._nanoseconds.toString());
+
+    this._nanoseconds = total;
+    this._handle = rclnodejs.createDuration(this._nanoseconds);
   }
 
   /**
    * Get the nanosecond part of the Duration.
    * @name Duration#get:nanoseconds
    * @function
-   * @return {number|string} - value in nanosecond, if the value is greater than Number.MAX_SAFE_INTEGER (2^53-1), will be presented in string of decimal format.
+   * @return {bigint} - value in nanosecond.
    */
 
   get nanoseconds() {
-    let nanoStr = rclnodejs.getDurationNanoseconds(this._handle);
-    let nano;
-
-    if (nanoStr.startsWith('-')) {
-      nano = int64.negative(int64.from(nanoStr));
-    } else {
-      nano = int64.from(nanoStr);
-    }
-    if (Number.isFinite(nano.toNumber())) {
-      return nano.toNumber();
-    }
-    return nano.toString();
+    return rclnodejs.getDurationNanoseconds(this._handle);
   }
 
   /**
@@ -78,7 +65,7 @@ class Duration {
    */
   eq(other) {
     if (other instanceof Duration) {
-      return this._nanoseconds.eq(other.nanoseconds);
+      return this._nanoseconds === other.nanoseconds;
     }
     throw new TypeError(
       `Can't compare duration with object of type: ${other.constructor.name}`
@@ -92,7 +79,7 @@ class Duration {
    */
   ne(other) {
     if (other instanceof Duration) {
-      return this._nanoseconds.ne(other.nanoseconds);
+      return this._nanoseconds !== other.nanoseconds;
     }
     throw new TypeError('Invalid argument');
   }
@@ -104,7 +91,7 @@ class Duration {
    */
   lt(other) {
     if (other instanceof Duration) {
-      return this._nanoseconds.lt(other.nanoseconds);
+      return this._nanoseconds < other.nanoseconds;
     }
     throw new TypeError('Invalid argument');
   }
@@ -116,7 +103,7 @@ class Duration {
    */
   lte(other) {
     if (other instanceof Duration) {
-      return this._nanoseconds.lte(other.nanoseconds);
+      return this._nanoseconds <= other.nanoseconds;
     }
     throw new TypeError('Invalid argument');
   }
@@ -128,7 +115,7 @@ class Duration {
    */
   gt(other) {
     if (other instanceof Duration) {
-      return this._nanoseconds.gt(other.nanoseconds);
+      return this._nanoseconds > other.nanoseconds;
     }
     throw new TypeError('Invalid argument');
   }
@@ -140,7 +127,7 @@ class Duration {
    */
   gte(other) {
     if (other instanceof Duration) {
-      return this._nanoseconds.gte(other.nanoseconds);
+      return this._nanoseconds >= other.nanoseconds;
     }
     throw new TypeError('Invalid argument');
   }

package/lib/node.js

@@ -507,7 +507,7 @@ class Node extends rclnodejs.ShadowNode {
 
   /**
    * Create a Timer.
-   * @param {number} period - The number representing period in millisecond.
+   * @param {bigint} period - The number representing period in nanoseconds.
    * @param {function} callback - The callback to be called when timeout.
    * @param {Clock} [clock] - The clock which the timer gets time from.
    * @return {Timer} - An instance of Timer.
@@ -519,22 +519,11 @@ class Node extends rclnodejs.ShadowNode {
       clock = arguments[3];
     }
 
-    if (typeof period !== 'number' || typeof callback !== 'function') {
+    if (typeof period !== 'bigint' || typeof callback !== 'function') {
       throw new TypeError('Invalid argument');
     }
 
-    // The period unit is millisecond in JavaScript side. When being passed to the
-    // C++ side, the value will be converted to nanosecond, which goes into a uint64_t
-    // with maxmium value of 2^64-1. So the maxmium is UINT64_MAX in ns, that's 0x10c6f7a0b5ed in ms.
-    const MAX_TIMER_PERIOD_IN_MILLISECOND = 0x10c6f7a0b5ed;
-    if (period > 0x10c6f7a0b5ed || period < 0) {
-      throw new RangeError(
-        `Parameter must be between 0.0 and ${MAX_TIMER_PERIOD_IN_MILLISECOND}`
-      );
-    }
-
     const timerClock = clock || this._clock;
-
     let timerHandle = rclnodejs.createTimer(
       timerClock.handle,
       this.context.handle,
@@ -573,7 +562,7 @@ class Node extends rclnodejs.ShadowNode {
     }
 
     const period = Math.round(1000 / hz);
-    const timer = this._rateTimerServer.createTimer(period);
+    const timer = this._rateTimerServer.createTimer(BigInt(period) * 1000000n);
     const rate = new Rates.Rate(hz, timer);
 
     return rate;
@@ -1480,10 +1469,10 @@ class Node extends rclnodejs.ShadowNode {
       PARAMETER_EVENT_MSG_TYPE
     ))();
 
-    const secondsAndNanos = this._clock.now().secondsAndNanoseconds;
+    const { seconds, nanoseconds } = this._clock.now().secondsAndNanoseconds;
     parameterEvent.stamp = {
-      sec: secondsAndNanos.seconds,
-      nanosec: secondsAndNanos.nanoseconds,
+      sec: Number(seconds),
+      nanosec: Number(nanoseconds),
     };
 
     parameterEvent.node =

package/lib/parameter.js

@@ -34,6 +34,7 @@ const rclnodejs = require('bindings')('rclnodejs');
 const DEFAULT_NUMERIC_RANGE_TOLERANCE = 1e-6;
 
 const PARAMETER_SEPARATOR = '.';
+const PARAMETER_BYTE = 10;
 
 /**
  * Enum for ParameterType
@@ -125,7 +126,9 @@ class Parameter {
   constructor(name, type, value) {
     this._name = name;
     this._type = type;
-    this._value = value;
+    // Convert to bigint if it's type of `PARAMETER_INTEGER`.
+    this._value =
+      this._type == ParameterType.PARAMETER_INTEGER ? BigInt(value) : value;
     this._isDirty = true;
 
     this.validate();
@@ -240,10 +243,10 @@ class Parameter {
         msg.double_array_value = this.value;
         break;
       case ParameterType.PARAMETER_INTEGER:
-        msg.integer_value = Math.trunc(this.value);
+        msg.integer_value = this.value;
         break;
       case ParameterType.PARAMETER_INTEGER_ARRAY:
-        msg.integer_array_value = this.value.map((val) => Math.trunc(val));
+        msg.integer_array_value = this.value;
         break;
       case ParameterType.PARAMETER_STRING:
         msg.string_value = this.value;
@@ -537,10 +540,10 @@ class Range {
 
   /**
    * Determine if a value is within this range.
-   * A TypeError is thrown when value is not a number.
+   * A TypeError is thrown when value is not a number or bigint.
    * Subclasses should override and call this method for basic type checking.
    *
-   * @param {number} value - The number to check.
+   * @param {number|bigint} value - The number or bigint to check.
    * @return {boolean} - True if value satisfies the range; false otherwise.
    */
   inRange(value) {
@@ -550,8 +553,8 @@ class Range {
         (inRange, val) => inRange && this.inRange(val),
         true
       );
-    } else if (typeof value !== 'number') {
-      throw new TypeError('Value must be a number');
+    } else if (typeof value !== 'number' && typeof value !== 'bigint') {
+      throw new TypeError('Value must be a number or bigint');
     }
 
     return true;
@@ -652,27 +655,16 @@ class FloatingPointRange extends Range {
  * Defines a range for integer values.
  * @class
  */
-class IntegerRange extends FloatingPointRange {
+class IntegerRange extends Range {
   /**
    * Create a new instance.
    * @constructor
-   * @param {number} fromValue - The lowest inclusive value in range
-   * @param {number} toValue - The highest inclusive value in range
-   * @param {number} step - The internal unit size.
-   * @param {number} tolerance - The plus/minus tolerance for number equivalence.
+   * @param {bigint} fromValue - The lowest inclusive value in range
+   * @param {bigint} toValue - The highest inclusive value in range
+   * @param {bigint} step - The internal unit size.
    */
-  constructor(
-    fromValue,
-    toValue,
-    step = 1,
-    tolerance = DEFAULT_NUMERIC_RANGE_TOLERANCE
-  ) {
-    super(
-      Math.trunc(fromValue),
-      Math.trunc(toValue),
-      Math.trunc(step),
-      tolerance
-    );
+  constructor(fromValue, toValue, step = 1n) {
+    super(fromValue, toValue, step);
   }
 
   /**
@@ -683,12 +675,23 @@ class IntegerRange extends FloatingPointRange {
    */
   isValidType(parameterType) {
     const result =
-      parameterType === ParameterType.PARAMETER_BYTE ||
-      parameterType === ParameterType.PARAMETER_BYTE_ARRAY ||
       parameterType === ParameterType.PARAMETER_INTEGER ||
       parameterType === ParameterType.PARAMETER_INTEGER_ARRAY;
     return result;
   }
+
+  inRange(value) {
+    const min = this.fromValue;
+    const max = this.toValue;
+    if (value < min || value > max) {
+      return false;
+    }
+
+    if (this.step != 0n && (value - min) % this.step !== 0n) {
+      return false;
+    }
+    return true;
+  }
 }
 
 /**
@@ -763,10 +766,13 @@ function validValue(value, type) {
     case ParameterType.PARAMETER_STRING:
       result = typeof value === 'string';
       break;
-    case ParameterType.PARAMETER_INTEGER:
     case ParameterType.PARAMETER_DOUBLE:
+    case PARAMETER_BYTE:
       result = typeof value === 'number';
       break;
+    case ParameterType.PARAMETER_INTEGER:
+      result = typeof value === 'bigint';
+      break;
     case ParameterType.PARAMETER_BOOL_ARRAY:
     case ParameterType.PARAMETER_BYTE_ARRAY:
     case ParameterType.PARAMETER_INTEGER_ARRAY:
@@ -789,7 +795,7 @@ function _validArray(values, type) {
   if (type === ParameterType.PARAMETER_BOOL_ARRAY) {
     arrayElementType = ParameterType.PARAMETER_BOOL;
   } else if (type === ParameterType.PARAMETER_BYTE_ARRAY) {
-    arrayElementType = ParameterType.PARAMETER_INTEGER;
+    arrayElementType = PARAMETER_BYTE;
   }
   if (type === ParameterType.PARAMETER_INTEGER_ARRAY) {
     arrayElementType = ParameterType.PARAMETER_INTEGER;

package/lib/rate.js

@@ -166,7 +166,7 @@ class RateTimerServer {
   /**
    * Create a new timer instance with callback set to NOP.
    *
-   * @param {number} period - The period in milliseconds
+   * @param {bigint} period - The period in nanoseconds.
    * @returns {Timer} - The new timer instance.
    */
   createTimer(period) {