[Doc] Switch npmjs README examples to ESM#1542
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the npm-published README (scripts/npmjs-readme.md) to reflect rclnodejs’s ESM-first usage patterns, aligning documentation with the package’s modern Node/TypeScript configuration expectations (issue #1541).
Changes:
- Replaces the CommonJS
require()+init().then()quick-start with native ESMimportand top-levelawait rclnodejs.init(). - Updates the recommended TypeScript
tsconfig.jsonsnippet tomodule/moduleResolution: NodeNextandtarget: es2022.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| node.spin(); | ||
| ``` | ||
|
|
||
| This example assumes your ROS 2 environment is already sourced. |
|
coverage: 91.22% (+0.001%) from 91.219% — minggangw:fix-1541 into RobotWebTools:develop |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Align the npm-published README (scripts/npmjs-readme.md) with the package's ESM-first API.
require()+init().then()form with native ESMimport rclnodejs from 'rclnodejs'and top-levelawait rclnodejs.init().commonjs/node/es2020toNodeNext/NodeNext/es2022to match ESM module resolution.Fix: #1541