doc: add example of self-reference in scoped packages

PR-URL: #37630 Fixes: #37618 Refs: #37618 (comment) Co-authored-by: Michaël Zasso <[email protected]> Reviewed-By: Guy Bedford <[email protected]>
nodejs · Aug 22, 2021 · a387600 · a387600
1 parent 7a25bf3
commit a387600
Showing 1 changed file with 26 additions and 0 deletions.
diff --git a/doc/api/packages.md b/doc/api/packages.md
@@ -709,6 +709,32 @@ and in a CommonJS one. For example, this code will also work:
 const { something } = require('a-package/foo'); // Loads from ./foo.js.
 ```
 
+Finally, self-referencing also works with scoped packages. For example, this
+code will also work:
+
+```json
+// package.json
+{
+  "name": "@my/package",
+  "exports": "./index.js"
+}
+```
+
+```js
+// ./index.js
+module.exports = 42;
+```
+
+```js
+// ./other.js
+console.log(require('@my/package'));
+```
+
+```console
+$ node other.js
+42
+```
+
 ## Dual CommonJS/ES module packages
 
 Prior to the introduction of support for ES modules in Node.js, it was a common