Document module import methods #19

lejeunerenard · 2024-11-25T19:03:04Z

No description provided.

Add `require()`, `require.addon()`, `require.asset()` & `import.meta.resolve`.

The links jump to `Module.cache` not `module.cache` because anchors are lowercase and `Module.cache` comes first.

kasperisager

Looks great! Could you document require.resolve() as well which is functionally equivalent to import.meta.resolve()?

README.md

Co-authored-by: Kasper Isager Dalsgarð <[email protected]>

…lt value Co-authored-by: Kasper Isager Dalsgarð <[email protected]>

Co-authored-by: Kasper Isager Dalsgarð <[email protected]>

lejeunerenard · 2025-01-03T21:17:15Z

@kasperisager good catch on require.resolve(), sorry about that! Now added.
While working on it, I also realized I incorrectly marked some of the method parameters as optional / having default values. Those were fixed in 1e5d861.

kasperisager

Good point on the non-optional arguments, I missed that as well! LGTM! 🚀

lejeunerenard added 20 commits November 25, 2024 13:30

Add import methods to README.md

fcda60a

Add `require()`, `require.addon()`, `require.asset()` & `import.meta.resolve`.

Clarify return values and types for import method in readme

fc84f3f

Add header for import methods in README.md

46a0df4

Fix typo in readme example for require.asset()

12c4cd8

Split import methods into CommonJS vs ESM in README docs

4ee7afa

Add require.addon.host to readme

e918597

Add require.addon.resolve() to readme

0c1cb12

Add require.main to readme

4548160

Add require.cache to readme

0bba44b

Add brief import docs to readme

98e2270

Add import.meta.url to readme

8266d87

Add import.meta.main to readme

c581ef3

Add import.meta.cache to readme

a935c88

Add import.meta.addon() to readme

e2ea64a

Add import.meta.addon.host to readme

e0b2262

Add import.meta.addon.resolve() to readme

df5ab40

Add import.meta.asset() to readme

7b94d87

Remove module.cache links

4a1f6a4

The links jump to `Module.cache` not `module.cache` because anchors are lowercase and `Module.cache` comes first.

Lint README.md using _ instead of * for italics

5bb698d

Clarify that import.meta.asset() & *.resolve() return URL strings

341c468

kasperisager assigned kasperisager and unassigned kasperisager Jan 2, 2025

kasperisager self-requested a review January 2, 2025 21:28

kasperisager requested changes Jan 3, 2025

View reviewed changes

lejeunerenard and others added 6 commits January 3, 2025 12:11

Use optional syntax for options in require()

a50a4ae

Co-authored-by: Kasper Isager Dalsgarð <[email protected]>

Use optional syntax in require.add() doc in README.md

3d02454

Co-authored-by: Kasper Isager Dalsgarð <[email protected]>

Fix typos, adjust headers to be succinct & expand abbreviations

2998c2b

Co-authored-by: Kasper Isager Dalsgarð <[email protected]>

Adjust README.md docs to use option parameter syntax instead of defau…

0d1e2e8

…lt value Co-authored-by: Kasper Isager Dalsgarð <[email protected]>

Clarify how require() interprets paths and what it can load

b46f1df

Co-authored-by: Kasper Isager Dalsgarð <[email protected]>

Add require.resolve() documentation to README.md

04d7b87

Fix optional parameter syntax typos in README.md

1e5d861

kasperisager approved these changes Jan 3, 2025

View reviewed changes

kasperisager merged commit 4b3a6d0 into holepunchto:main Jan 4, 2025
3 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document module import methods #19

Document module import methods #19

lejeunerenard commented Nov 25, 2024

kasperisager left a comment

lejeunerenard commented Jan 3, 2025

kasperisager left a comment

Document module import methods #19

Document module import methods #19

Conversation

lejeunerenard commented Nov 25, 2024

kasperisager left a comment

Choose a reason for hiding this comment

lejeunerenard commented Jan 3, 2025

kasperisager left a comment

Choose a reason for hiding this comment