Skip to content

Commit a58e00b

Browse files
author
Letícia
committed
docs: update README
1 parent f52db14 commit a58e00b

File tree

1 file changed

+44
-43
lines changed

1 file changed

+44
-43
lines changed

README.md

Lines changed: 44 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
A Vite plugin to polyfill Node's Core Modules for browser environments. Supports [`node:` protocol imports](https://nodejs.org/dist/latest-v16.x/docs/api/esm.html#node-imports).
44

5-
### Why do I need this?
5+
## Why do I need this?
66

77
```
88
Module "stream" has been externalized for browser compatibility. Cannot access "stream.Readable" in client code.
@@ -56,45 +56,46 @@ export default defineConfig({
5656

5757
### All polyfills
5858

59-
'assert',
60-
'buffer',
61-
'child_process',
62-
'cluster',
63-
'console',
64-
'constants',
65-
'crypto',
66-
'dgram',
67-
'dns',
68-
'domain',
69-
'events',
70-
'fs',
71-
'http',
72-
'https',
73-
'http2',
74-
'module',
75-
'net',
76-
'os',
77-
'path',
78-
'punycode',
79-
'process',
80-
'querystring',
81-
'readline',
82-
'repl',
83-
'stream',
84-
'_stream_duplex',
85-
'_stream_passthrough',
86-
'_stream_readable',
87-
'_stream_transform',
88-
'_stream_writable',
89-
'string_decoder',
90-
'sys',
91-
'timers/promises',
92-
'timers',
93-
'tls',
94-
'tty',
95-
'url',
96-
'util',
97-
'vm',
98-
'zlib',
99-
100-
plus the node:[lib] if protocolImports is true
59+
- If protocolImports is true, also adds node:[module]
60+
```js
61+
'assert',
62+
'buffer',
63+
'child_process',
64+
'cluster',
65+
'console',
66+
'constants',
67+
'crypto',
68+
'dgram',
69+
'dns',
70+
'domain',
71+
'events',
72+
'fs',
73+
'http',
74+
'https',
75+
'http2',
76+
'module',
77+
'net',
78+
'os',
79+
'path',
80+
'punycode',
81+
'process',
82+
'querystring',
83+
'readline',
84+
'repl',
85+
'stream',
86+
'_stream_duplex',
87+
'_stream_passthrough',
88+
'_stream_readable',
89+
'_stream_transform',
90+
'_stream_writable',
91+
'string_decoder',
92+
'sys',
93+
'timers/promises',
94+
'timers',
95+
'tls',
96+
'tty',
97+
'url',
98+
'util',
99+
'vm',
100+
'zlib',
101+
```

0 commit comments

Comments
 (0)