bun-types

Version:

Type definitions and documentation for Bun, an incredibly fast JavaScript runtime

73 lines (70 loc) • 24.9 kB

text/mdx

--- title: Globals description: Use Bun's global objects --- Bun implements the following globals. | Global | Source | Notes | | ----------------------------------------------------------------------------------------------------------------------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController) | Web | | | [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) | Web | | | [`alert`](https://developer.mozilla.org/en-US/docs/Web/API/Window/alert) | Web | Intended for command-line tools | | [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) | Web | | | [`Buffer`](https://nodejs.org/api/buffer.html#class-buffer) | Node.js | See [Node.js > `Buffer`](/docs/runtime/nodejs-compat#node-buffer) | | `Bun` | Bun | Subject to change as additional APIs are added | | [`ByteLengthQueuingStrategy`](https://developer.mozilla.org/en-US/docs/Web/API/ByteLengthQueuingStrategy) | Web | | | [`confirm`](https://developer.mozilla.org/en-US/docs/Web/API/Window/confirm) | Web | Intended for command-line tools | | [`__dirname`](https://nodejs.org/api/globals.html#__dirname) | Node.js | | | [`__filename`](https://nodejs.org/api/globals.html#__filename) | Node.js | | | [`atob()`](https://developer.mozilla.org/en-US/docs/Web/API/atob) | Web | | | [`btoa()`](https://developer.mozilla.org/en-US/docs/Web/API/btoa) | Web | | | `BuildMessage` | Bun | | | [`clearImmediate()`](https://developer.mozilla.org/en-US/docs/Web/API/Window/clearImmediate) | Web | | | [`clearInterval()`](https://developer.mozilla.org/en-US/docs/Web/API/Window/clearInterval) | Web | | | [`clearTimeout()`](https://developer.mozilla.org/en-US/docs/Web/API/Window/clearTimeout) | Web | | | [`console`](https://developer.mozilla.org/en-US/docs/Web/API/console) | Web | | | [`CountQueuingStrategy`](https://developer.mozilla.org/en-US/docs/Web/API/CountQueuingStrategy) | Web | | | [`Crypto`](https://developer.mozilla.org/en-US/docs/Web/API/Crypto) | Web | | | [`crypto`](https://developer.mozilla.org/en-US/docs/Web/API/crypto) | Web | | | [`CryptoKey`](https://developer.mozilla.org/en-US/docs/Web/API/CryptoKey) | Web | | | [`CustomEvent`](https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent) | Web | | | [`Event`](https://developer.mozilla.org/en-US/docs/Web/API/Event) | Web | Also [`ErrorEvent`](https://developer.mozilla.org/en-US/docs/Web/API/ErrorEvent) [`CloseEvent`](https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent) [`MessageEvent`](https://developer.mozilla.org/en-US/docs/Web/API/MessageEvent). | | [`EventTarget`](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget) | Web | | | [`exports`](https://nodejs.org/api/globals.html#exports) | Node.js | | | [`fetch`](https://developer.mozilla.org/en-US/docs/Web/API/fetch) | Web | | | [`FormData`](https://developer.mozilla.org/en-US/docs/Web/API/FormData) | Web | | | [`global`](https://nodejs.org/api/globals.html#global) | Node.js | See [Node.js > `global`](/docs/runtime/nodejs-compat#global). | | [`globalThis`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/globalThis) | Cross-platform | Aliases to `global` | | [`Headers`](https://developer.mozilla.org/en-US/docs/Web/API/Headers) | Web | | | [`HTMLRewriter`](/docs/runtime/html-rewriter) | Cloudflare | | | [`JSON`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON) | Web | | | [`MessageEvent`](https://developer.mozilla.org/en-US/docs/Web/API/MessageEvent) | Web | | | [`module`](https://nodejs.org/api/globals.html#module) | Node.js | | | [`performance`](https://developer.mozilla.org/en-US/docs/Web/API/performance) | Web | | | [`process`](https://nodejs.org/api/process.html) | Node.js | See [Node.js > `process`](/docs/runtime/nodejs-compat#node-process) | | [`prompt`](https://developer.mozilla.org/en-US/docs/Web/API/Window/prompt) | Web | Intended for command-line tools | | [`queueMicrotask()`](https://developer.mozilla.org/en-US/docs/Web/API/queueMicrotask) | Web | | | [`ReadableByteStreamController`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableByteStreamController) | Web | | | [`ReadableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream) | Web | | | [`ReadableStreamDefaultController`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStreamDefaultController) | Web | | | [`ReadableStreamDefaultReader`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStreamDefaultReader) | Web | | | [`reportError`](https://developer.mozilla.org/en-US/docs/Web/API/reportError) | Web | | | [`require()`](https://nodejs.org/api/globals.html#require) | Node.js | | | `ResolveMessage` | Bun | | | [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response) | Web | | | [`Request`](https://developer.mozilla.org/en-US/docs/Web/API/Request) | Web | | | [`setImmediate()`](https://developer.mozilla.org/en-US/docs/Web/API/Window/setImmediate) | Web | | | [`setInterval()`](https://developer.mozilla.org/en-US/docs/Web/API/Window/setInterval) | Web | | | [`setTimeout()`](https://developer.mozilla.org/en-US/docs/Web/API/Window/setTimeout) | Web | | | [`ShadowRealm`](https://github.com/tc39/proposal-shadowrealm) | Web | Stage 3 proposal | | [`SubtleCrypto`](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto) | Web | | | [`DOMException`](https://developer.mozilla.org/en-US/docs/Web/API/DOMException) | Web | | | [`TextDecoder`](https://developer.mozilla.org/en-US/docs/Web/API/TextDecoder) | Web | | | [`TextEncoder`](https://developer.mozilla.org/en-US/docs/Web/API/TextEncoder) | Web | | | [`TransformStream`](https://developer.mozilla.org/en-US/docs/Web/API/TransformStream) | Web | | | [`TransformStreamDefaultController`](https://developer.mozilla.org/en-US/docs/Web/API/TransformStreamDefaultController) | Web | | | [`URL`](https://developer.mozilla.org/en-US/docs/Web/API/URL) | Web | | | [`URLSearchParams`](https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams) | Web | | | [`WebAssembly`](https://nodejs.org/api/globals.html#webassembly) | Web | | | [`WritableStream`](https://developer.mozilla.org/en-US/docs/Web/API/WritableStream) | Web | | | [`WritableStreamDefaultController`](https://developer.mozilla.org/en-US/docs/Web/API/WritableStreamDefaultController) | Web | | | [`WritableStreamDefaultWriter`](https://developer.mozilla.org/en-US/docs/Web/API/WritableStreamDefaultWriter) | Web | |