diff options
author | 2023-02-23 17:13:30 -0800 | |
---|---|---|
committer | 2023-02-23 17:13:30 -0800 | |
commit | f54300578b1edc7f67daddbfae29575cbf305264 (patch) | |
tree | 1437f3274122c011f879dca71f59a74d75a33fd0 /docs/api/globals.md | |
parent | 5929daeeae1f528abab31979a0a28bc87a03b1f4 (diff) | |
download | bun-f54300578b1edc7f67daddbfae29575cbf305264.tar.gz bun-f54300578b1edc7f67daddbfae29575cbf305264.tar.zst bun-f54300578b1edc7f67daddbfae29575cbf305264.zip |
Add documentation (#2148)bun-v0.5.7
* Add documentation
* Tweaks
* Fixes
* Rearrange
* Update
Diffstat (limited to 'docs/api/globals.md')
-rw-r--r-- | docs/api/globals.md | 381 |
1 files changed, 381 insertions, 0 deletions
diff --git a/docs/api/globals.md b/docs/api/globals.md new file mode 100644 index 000000000..d966c1861 --- /dev/null +++ b/docs/api/globals.md @@ -0,0 +1,381 @@ +Bun implements the following globals. + +{% table %} + +- 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#node_buffer) + +--- + +- [`Bun`](https://nodejs.org/api/buffer.html#class-buffer) +- 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 +- + +--- + +- `BuildError` +- 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#node_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/api/html-rewriter) +- Cloudflare +- + +--- + +- [`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#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 +- + +--- + +- `ResolveError` +- 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 +- + +{% /table %} |