@blueyerobotics/protocol-definitions 3.3.0-e472bef2 → 3.4.0-618bf0b0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -8,6 +8,30 @@ TypeScript protobuf definitions for Blueye Robotics protocols generated using [t
8
8
  npm install @blueyerobotics/protocol-definitions
9
9
  ```
10
10
 
11
+ ## Module format
12
+
13
+ This package ships ES modules only — there is no separate CommonJS build. Both
14
+ `import` and `require()` work on current Node.js releases.
15
+
16
+ ```ts
17
+ import { blueye } from "@blueyerobotics/protocol-definitions";
18
+ ```
19
+
20
+ `require()` is supported on Node.js 22.12+ (or 20.19+), which can load an ES
21
+ module from CommonJS:
22
+
23
+ ```js
24
+ const { blueye } = require("@blueyerobotics/protocol-definitions");
25
+ ```
26
+
27
+ On older Node.js versions `require()` fails with `ERR_REQUIRE_ESM` — use `import`
28
+ or a dynamic `await import()` instead.
29
+
30
+ The package root is the supported entry point. Individual generated modules stay
31
+ reachable under `./dist/`, with or without the `.js` extension (for example
32
+ `@blueyerobotics/protocol-definitions/dist/telemetry`) if you want to import a
33
+ single protocol file to keep bundles small.
34
+
11
35
  ## Usage
12
36
 
13
37
  ```ts
package/README.npm.md CHANGED
@@ -8,6 +8,30 @@ TypeScript protobuf definitions for Blueye Robotics protocols generated using [t
8
8
  npm install @blueyerobotics/protocol-definitions
9
9
  ```
10
10
 
11
+ ## Module format
12
+
13
+ This package ships ES modules only — there is no separate CommonJS build. Both
14
+ `import` and `require()` work on current Node.js releases.
15
+
16
+ ```ts
17
+ import { blueye } from "@blueyerobotics/protocol-definitions";
18
+ ```
19
+
20
+ `require()` is supported on Node.js 22.12+ (or 20.19+), which can load an ES
21
+ module from CommonJS:
22
+
23
+ ```js
24
+ const { blueye } = require("@blueyerobotics/protocol-definitions");
25
+ ```
26
+
27
+ On older Node.js versions `require()` fails with `ERR_REQUIRE_ESM` — use `import`
28
+ or a dynamic `await import()` instead.
29
+
30
+ The package root is the supported entry point. Individual generated modules stay
31
+ reachable under `./dist/`, with or without the `.js` extension (for example
32
+ `@blueyerobotics/protocol-definitions/dist/telemetry`) if you want to import a
33
+ single protocol file to keep bundles small.
34
+
11
35
  ## Usage
12
36
 
13
37
  ```ts