diff --git a/README.md b/README.md index 4b748b865c..675dd5b261 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ Bun is an all-in-one toolkit for JavaScript and TypeScript apps. It ships as a single executable called `bun`. -At its core is the _Bun runtime_, a fast JavaScript runtime designed as a drop-in replacement for Node.js. It's written in Zig and powered by JavaScriptCore under the hood, dramatically reducing startup times and memory usage. +At its core is the _Bun runtime_, a fast JavaScript runtime designed as **a drop-in replacement for Node.js**. It's written in Zig and powered by JavaScriptCore under the hood, dramatically reducing startup times and memory usage. ```bash bun run index.tsx # TS and JSX supported out-of-the-box diff --git a/docs/index.md b/docs/index.md index 8a994cbcff..f7c3620f20 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@ Bun is an all-in-one toolkit for JavaScript and TypeScript apps. It ships as a single executable called `bun`. -At its core is the _Bun runtime_, a fast JavaScript runtime designed as a drop-in replacement for Node.js. It's written in Zig and powered by JavaScriptCore under the hood, dramatically reducing startup times and memory usage. +At its core is the _Bun runtime_, a fast JavaScript runtime designed as **a drop-in replacement for Node.js**. It's written in Zig and powered by JavaScriptCore under the hood, dramatically reducing startup times and memory usage. ```bash $ bun run index.tsx # TS and JSX supported out of the box diff --git a/docs/runtime/nodejs-apis.md b/docs/runtime/nodejs-apis.md index 13a6892ebd..a44920b648 100644 --- a/docs/runtime/nodejs-apis.md +++ b/docs/runtime/nodejs-apis.md @@ -1,4 +1,4 @@ -Every day, Bun gets closer to 100% Node.js API compatibility. Today, popular frameworks like Next.js, Express, and millions of `npm` packages intended for Node just work with Bun out of the box. To ensure compatibility, we run thousands of Node.js tests on every commit of Bun. +Every day, Bun gets closer to 100% Node.js API compatibility. Today, popular frameworks like Next.js, Express, and millions of `npm` packages intended for Node just work with Bun out of the box. To ensure compatibility, we run thousands of Node.js tests before every release of Bun. **If a package works in Node.js but doesn't work in Bun, we consider it a bug in Bun.** Please [open an issue](https://bun.sh/issues) and we'll fix it. @@ -80,7 +80,7 @@ This page is updated regularly to reflect compatibility status of the latest ver ### [`node:async_hooks`](https://nodejs.org/api/async_hooks.html) -🟡 Only `AsyncLocalStorage`, and `AsyncResource` are implemented. `AsyncResource` is missing `bind`. +🟡 `AsyncLocalStorage`, and `AsyncResource` are implemented. `AsyncResource` is missing `bind`. v8 hooks are stubbed. ### [`node:child_process`](https://nodejs.org/api/child_process.html) @@ -335,7 +335,7 @@ The table below lists all globals implemented by Node.js and Bun's current compa ### [`PerformanceResourceTiming`](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming) -🔴 Not implemented. +🟢 Fully implemented. ### [`performance`](https://developer.mozilla.org/en-US/docs/Web/API/performance) @@ -343,7 +343,7 @@ The table below lists all globals implemented by Node.js and Bun's current compa ### [`process`](https://nodejs.org/api/process.html) -🟡 Missing `initgroups` `allowedNodeEnvironmentFlags` `getActiveResourcesInfo` `setActiveResourcesInfo` `moduleLoadList` `setSourceMapsEnabled`. `process.binding` is partially implemented. +🟡 `process.binding` (internal Node.js bindings) is partially implemented. `process.title` is a currently a no-op on macOS & Linux. `getActiveResourcesInfo` `setActiveResourcesInfo`, `getActiveResources` and `setSourceMapsEnabled` are stubs. Newer APIs like `process.loadEnvFile` and `process.getBuiltinModule` are not implemented yet. ### [`queueMicrotask()`](https://developer.mozilla.org/en-US/docs/Web/API/queueMicrotask)