thunderstrike/puppeteer
thunderstrike/puppeteer
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
523b487e88
puppeteer/compat
History
jrandolf 523b487e88
feat(puppeteer): export esm modules in package.json (#7964) 
* feat(puppeteer): export esm modules in package.json

Signed-off-by: Randolf Jung <jrandolf@chromium.org>

Co-authored-by: Alex Rudenko <OrKoN@users.noreply.github.com>
Co-authored-by: Randolf Jung <jrandolf@chromium.org>
2022-02-09 07:47:27 +00:00
..
cjs feat(puppeteer): export esm modules in package.json (#7964) 2022-02-09 07:47:27 +00:00
esm feat(puppeteer): export esm modules in package.json (#7964) 2022-02-09 07:47:27 +00:00
README.md feat(puppeteer): export esm modules in package.json (#7964) 2022-02-09 07:47:27 +00:00

README.md

Compatibility layer

This directory provides an additional compatibility layer between ES modules and CommonJS.

Why?

Both ./cjs/compat.ts and ./esm/compat.ts are written as ES modules, but ./cjs/compat.ts can additionally use NodeJS CommonJS globals such as __dirname and require while these are disabled in ES module mode. For more information, see Differences between ES modules and CommonJS.

Adding exports

In order to add exports, two things need to be done:

  • The exports must be declared in src/compat.ts.
  • The exports must be realized in ./cjs/compat.ts and ./esm/compat.ts.

In the event compat.ts becomes too large, you can place declarations in another file. Just make sure ./cjs, ./esm, and src have the same structure.