bun-types 1.3.2-canary.20251104T140728 → 1.3.2-canary.20251106T140813

package/docs/api/globals.md

@@ -1,387 +0,0 @@
-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`](https://bun.com/docs/runtime/nodejs-apis#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`](https://bun.com/docs/runtime/nodejs-apis#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`](https://bun.com/docs/api/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`](https://bun.com/docs/runtime/nodejs-apis#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
--  
-
-{% /table %}

package/docs/api/hashing.md

@@ -1,319 +0,0 @@
-{% callout %}
-
-Bun implements the `createHash` and `createHmac` functions from [`node:crypto`](https://nodejs.org/api/crypto.html) in addition to the Bun-native APIs documented below.
-
-{% /callout %}
-
-## `Bun.password`
-
-`Bun.password` is a collection of utility functions for hashing and verifying passwords with various cryptographically secure algorithms.
-
-```ts
-const password = "super-secure-pa$$word";
-
-const hash = await Bun.password.hash(password);
-// => $argon2id$v=19$m=65536,t=2,p=1$tFq+9AVr1bfPxQdh6E8DQRhEXg/M/SqYCNu6gVdRRNs$GzJ8PuBi+K+BVojzPfS5mjnC8OpLGtv8KJqF99eP6a4
-
-const isMatch = await Bun.password.verify(password, hash);
-// => true
-```
-
-The second argument to `Bun.password.hash` accepts a params object that lets you pick and configure the hashing algorithm.
-
-```ts
-const password = "super-secure-pa$$word";
-
-// use argon2 (default)
-const argonHash = await Bun.password.hash(password, {
-  algorithm: "argon2id", // "argon2id" | "argon2i" | "argon2d"
-  memoryCost: 4, // memory usage in kibibytes
-  timeCost: 3, // the number of iterations
-});
-
-// use bcrypt
-const bcryptHash = await Bun.password.hash(password, {
-  algorithm: "bcrypt",
-  cost: 4, // number between 4-31
-});
-```
-
-The algorithm used to create the hash is stored in the hash itself. When using `bcrypt`, the returned hash is encoded in [Modular Crypt Format](https://passlib.readthedocs.io/en/stable/modular_crypt_format.html) for compatibility with most existing `bcrypt` implementations; with `argon2` the result is encoded in the newer [PHC format](https://github.com/P-H-C/phc-string-format/blob/master/phc-sf-spec.md).
-
-The `verify` function automatically detects the algorithm based on the input hash and use the correct verification method. It can correctly infer the algorithm from both PHC- or MCF-encoded hashes.
-
-```ts
-const password = "super-secure-pa$$word";
-
-const hash = await Bun.password.hash(password, {
-  /* config */
-});
-
-const isMatch = await Bun.password.verify(password, hash);
-// => true
-```
-
-Synchronous versions of all functions are also available. Keep in mind that these functions are computationally expensive, so using a blocking API may degrade application performance.
-
-```ts
-const password = "super-secure-pa$$word";
-
-const hash = Bun.password.hashSync(password, {
-  /* config */
-});
-
-const isMatch = Bun.password.verifySync(password, hash);
-// => true
-```
-
-### Salt
-
-When you use `Bun.password.hash`, a salt is automatically generated and included in the hash.
-
-### bcrypt - Modular Crypt Format
-
-In the following [Modular Crypt Format](https://passlib.readthedocs.io/en/stable/modular_crypt_format.html) hash (used by `bcrypt`):
-
-Input:
-
-```ts
-await Bun.password.hash("hello", {
-  algorithm: "bcrypt",
-});
-```
-
-Output:
-
-```sh
-$2b$10$Lyj9kHYZtiyfxh2G60TEfeqs7xkkGiEFFDi3iJGc50ZG/XJ1sxIFi;
-```
-
-The format is composed of:
-
-- `bcrypt`: `$2b`
-- `rounds`: `$10` - rounds (log10 of the actual number of rounds)
-- `salt`: `$Lyj9kHYZtiyfxh2G60TEfeqs7xkkGiEFFDi3iJGc50ZG/XJ1sxIFi`
-- `hash`: `$GzJ8PuBi+K+BVojzPfS5mjnC8OpLGtv8KJqF99eP6a4`
-
-By default, the bcrypt library truncates passwords longer than 72 bytes. In Bun, if you pass `Bun.password.hash` a password longer than 72 bytes and use the `bcrypt` algorithm, the password will be hashed via SHA-512 before being passed to bcrypt.
-
-```ts
-await Bun.password.hash("hello".repeat(100), {
-  algorithm: "bcrypt",
-});
-```
-
-So instead of sending bcrypt a 500-byte password silently truncated to 72 bytes, Bun will hash the password using SHA-512 and send the hashed password to bcrypt (only if it exceeds 72 bytes). This is a more secure default behavior.
-
-### argon2 - PHC format
-
-In the following [PHC format](https://github.com/P-H-C/phc-string-format/blob/master/phc-sf-spec.md) hash (used by `argon2`):
-
-Input:
-
-```ts
-await Bun.password.hash("hello", {
-  algorithm: "argon2id",
-});
-```
-
-Output:
-
-```sh
-$argon2id$v=19$m=65536,t=2,p=1$xXnlSvPh4ym5KYmxKAuuHVlDvy2QGHBNuI6bJJrRDOs$2YY6M48XmHn+s5NoBaL+ficzXajq2Yj8wut3r0vnrwI
-```
-
-The format is composed of:
-
-- `algorithm`: `$argon2id`
-- `version`: `$v=19`
-- `memory cost`: `65536`
-- `iterations`: `t=2`
-- `parallelism`: `p=1`
-- `salt`: `$xXnlSvPh4ym5KYmxKAuuHVlDvy2QGHBNuI6bJJrRDOs`
-- `hash`: `$2YY6M48XmHn+s5NoBaL+ficzXajq2Yj8wut3r0vnrwI`
-
-## `Bun.hash`
-
-`Bun.hash` is a collection of utilities for _non-cryptographic_ hashing. Non-cryptographic hashing algorithms are optimized for speed of computation over collision-resistance or security.
-
-The standard `Bun.hash` functions uses [Wyhash](https://github.com/wangyi-fudan/wyhash) to generate a 64-bit hash from an input of arbitrary size.
-
-```ts
-Bun.hash("some data here");
-// 11562320457524636935n
-```
-
-The input can be a string, `TypedArray`, `DataView`, `ArrayBuffer`, or `SharedArrayBuffer`.
-
-```ts
-const arr = new Uint8Array([1, 2, 3, 4]);
-
-Bun.hash("some data here");
-Bun.hash(arr);
-Bun.hash(arr.buffer);
-Bun.hash(new DataView(arr.buffer));
-```
-
-Optionally, an integer seed can be specified as the second parameter. For 64-bit hashes seeds above `Number.MAX_SAFE_INTEGER` should be given as BigInt to avoid loss of precision.
-
-```ts
-Bun.hash("some data here", 1234);
-// 15724820720172937558n
-```
-
-Additional hashing algorithms are available as properties on `Bun.hash`. The API is the same for each, only changing the return type from number for 32-bit hashes to bigint for 64-bit hashes.
-
-```ts
-Bun.hash.wyhash("data", 1234); // equivalent to Bun.hash()
-Bun.hash.crc32("data", 1234);
-Bun.hash.adler32("data", 1234);
-Bun.hash.cityHash32("data", 1234);
-Bun.hash.cityHash64("data", 1234);
-Bun.hash.xxHash32("data", 1234);
-Bun.hash.xxHash64("data", 1234);
-Bun.hash.xxHash3("data", 1234);
-Bun.hash.murmur32v3("data", 1234);
-Bun.hash.murmur32v2("data", 1234);
-Bun.hash.murmur64v2("data", 1234);
-Bun.hash.rapidhash("data", 1234);
-```
-
-## `Bun.CryptoHasher`
-
-`Bun.CryptoHasher` is a general-purpose utility class that lets you incrementally compute a hash of string or binary data using a range of cryptographic hash algorithms. The following algorithms are supported:
-
-- `"blake2b256"`
-- `"blake2b512"`
-- `"blake2s256"`
-- `"md4"`
-- `"md5"`
-- `"ripemd160"`
-- `"sha1"`
-- `"sha224"`
-- `"sha256"`
-- `"sha384"`
-- `"sha512"`
-- `"sha512-224"`
-- `"sha512-256"`
-- `"sha3-224"`
-- `"sha3-256"`
-- `"sha3-384"`
-- `"sha3-512"`
-- `"shake128"`
-- `"shake256"`
-
-```ts
-const hasher = new Bun.CryptoHasher("sha256");
-hasher.update("hello world");
-hasher.digest();
-// Uint8Array(32) [ <byte>, <byte>, ... ]
-```
-
-Once initialized, data can be incrementally fed to to the hasher using `.update()`. This method accepts `string`, `TypedArray`, and `ArrayBuffer`.
-
-```ts
-const hasher = new Bun.CryptoHasher("sha256");
-
-hasher.update("hello world");
-hasher.update(new Uint8Array([1, 2, 3]));
-hasher.update(new ArrayBuffer(10));
-```
-
-If a `string` is passed, an optional second parameter can be used to specify the encoding (default `'utf-8'`). The following encodings are supported:
-
-{% table %}
-
----
-
-- Binary encodings
-- `"base64"` `"base64url"` `"hex"` `"binary"`
-
----
-
-- Character encodings
-- `"utf8"` `"utf-8"` `"utf16le"` `"latin1"`
-
----
-
-- Legacy character encodings
-- `"ascii"` `"binary"` `"ucs2"` `"ucs-2"`
-
-{% /table %}
-
-```ts
-hasher.update("hello world"); // defaults to utf8
-hasher.update("hello world", "hex");
-hasher.update("hello world", "base64");
-hasher.update("hello world", "latin1");
-```
-
-After the data has been feed into the hasher, a final hash can be computed using `.digest()`. By default, this method returns a `Uint8Array` containing the hash.
-
-```ts
-const hasher = new Bun.CryptoHasher("sha256");
-hasher.update("hello world");
-
-hasher.digest();
-// => Uint8Array(32) [ 185, 77, 39, 185, 147, ... ]
-```
-
-The `.digest()` method can optionally return the hash as a string. To do so, specify an encoding:
-
-```ts
-hasher.digest("base64");
-// => "uU0nuZNNPgilLlLX2n2r+sSE7+N6U4DukIj3rOLvzek="
-
-hasher.digest("hex");
-// => "b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9"
-```
-
-Alternatively, the method can write the hash into a pre-existing `TypedArray` instance. This may be desirable in some performance-sensitive applications.
-
-```ts
-const arr = new Uint8Array(32);
-
-hasher.digest(arr);
-
-console.log(arr);
-// => Uint8Array(32) [ 185, 77, 39, 185, 147, ... ]
-```
-
-### HMAC in `Bun.CryptoHasher`
-
-`Bun.CryptoHasher` can be used to compute HMAC digests. To do so, pass the key to the constructor.
-
-```ts
-const hasher = new Bun.CryptoHasher("sha256", "secret-key");
-hasher.update("hello world");
-console.log(hasher.digest("hex"));
-// => "095d5a21fe6d0646db223fdf3de6436bb8dfb2fab0b51677ecf6441fcf5f2a67"
-```
-
-When using HMAC, a more limited set of algorithms are supported:
-
-- `"blake2b512"`
-- `"md5"`
-- `"sha1"`
-- `"sha224"`
-- `"sha256"`
-- `"sha384"`
-- `"sha512-224"`
-- `"sha512-256"`
-- `"sha512"`
-
-Unlike the non-HMAC `Bun.CryptoHasher`, the HMAC `Bun.CryptoHasher` instance is not reset after `.digest()` is called, and attempting to use the same instance again will throw an error.
-
-Other methods like `.copy()` and `.update()` are supported (as long as it's before `.digest()`), but methods like `.digest()` that finalize the hasher are not.
-
-```ts
-const hasher = new Bun.CryptoHasher("sha256", "secret-key");
-hasher.update("hello world");
-
-const copy = hasher.copy();
-copy.update("!");
-console.log(copy.digest("hex"));
-// => "3840176c3d8923f59ac402b7550404b28ab11cb0ef1fa199130a5c37864b5497"
-
-console.log(hasher.digest("hex"));
-// => "095d5a21fe6d0646db223fdf3de6436bb8dfb2fab0b51677ecf6441fcf5f2a67"
-```