diff options
| author |  Vyacheslav Kulik <slava.kulik27@gmail.com>
| 2023-09-10 21:30:46 +0300 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2023-09-10 11:30:46 -0700 |
| commit | 97153c5a5f036f636af3c75955b6548fbc87559d (patch) | |
| tree | e798c4389425c26485af617ccc5c85d670b529c7 | |
| parent | d48ff53e4ec4cb49172e0e96ca9890446f971a0e (diff) | |
| download | bun-97153c5a5f036f636af3c75955b6548fbc87559d.tar.gz bun-97153c5a5f036f636af3c75955b6548fbc87559d.tar.zst bun-97153c5a5f036f636af3c75955b6548fbc87559d.zip | |
Add compatibility page link to index.md (#4809)
Add a link to compatibility page (https://bun.sh/docs/runtime/nodejs-apis) to its reference in index.md, so it's easier to reach out to.
| -rw-r--r-- | docs/index.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/index.md b/docs/index.md index 23a7495b9..0cc294150 100644 --- a/docs/index.md +++ b/docs/index.md @@ -66,7 +66,7 @@ Bun is designed from the ground-up with today's JavaScript ecosystem in mind. - **TypeScript & JSX support**. You can directly execute `.jsx`, `.ts`, and `.tsx` files; Bun's transpiler converts these to vanilla JavaScript before execution. - **ESM & CommonJS compatibility**. The world is moving towards ES modules (ESM), but millions of packages on npm still require CommonJS. Bun recommends ES modules, but supports CommonJS. - **Web-standard APIs**. Bun implements standard Web APIs like `fetch`, `WebSocket`, and `ReadableStream`. Bun is powered by the JavaScriptCore engine, which is developed by Apple for Safari, so some APIs like [`Headers`](https://developer.mozilla.org/en-US/docs/Web/API/Headers) and [`URL`](https://developer.mozilla.org/en-US/docs/Web/API/URL) directly use [Safari's implementation](https://github.com/oven-sh/bun/blob/HEAD/src/bun.js/bindings/webcore/JSFetchHeaders.cpp). -- **Node.js compatibility**. In addition to supporting Node-style module resolution, Bun aims for full compatibility with built-in Node.js globals (`process`, `Buffer`) and modules (`path`, `fs`, `http`, etc.) _This is an ongoing effort that is not complete._ Refer to the compatibility page for the current status. +- **Node.js compatibility**. In addition to supporting Node-style module resolution, Bun aims for full compatibility with built-in Node.js globals (`process`, `Buffer`) and modules (`path`, `fs`, `http`, etc.) _This is an ongoing effort that is not complete._ Refer to the [compatibility page](https://bun.sh/docs/runtime/nodejs-apis) for the current status. Bun is more than a runtime. The long-term goal is to be a cohesive, infrastructural toolkit for building apps with JavaScript/TypeScript, including a package manager, transpiler, bundler, script runner, test runner, and more. |