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

package/docs/guides/install/yarnlock.md

@@ -1,44 +0,0 @@
----
-name: Generate a yarn-compatible lockfile
----
-
-{% callout %}
-Bun v1.1.39 introduced `bun.lock`, a JSONC formatted lockfile. `bun.lock` is human-readable and git-diffable without configuration, at no cost to performance. [**Learn more.**](https://bun.com/docs/install/lockfile#text-based-lockfile)
-{% /callout %}
-
----
-
-Use the `--yarn` flag to generate a Yarn-compatible `yarn.lock` file (in addition to `bun.lock`).
-
-```sh
-$ bun install --yarn
-```
-
----
-
-To set this as the default behavior, add the following to your `bunfig.toml` file.
-
-```toml#bunfig.toml
-[install.lockfile]
-print = "yarn"
-```
-
----
-
-To print a Yarn lockfile to your console without writing it to disk, "run" your `bun.lockb` with `bun`.
-
-```sh
-$ bun bun.lockb
-# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
-# yarn lockfile v1
-# bun ./bun.lockb --hash: 9BFBF11D86084AAB-9418b03ff880c569-390CE6459EACEC9A...
-
-abab@^2.0.6:
-  version "2.0.6"
-  resolved "https://registry.npmjs.org/abab/-/abab-2.0.6.tgz"
-  integrity sha512-j2afSsaIENvHZN2B8GOpF566vZ5WVk5opAiMTvWgaQT8DkbOqsTfvNAvH...
-```
-
----
-
-See [Docs > Package manager](https://bun.com/docs/cli/install) for complete documentation of Bun's package manager.

package/docs/guides/process/argv.md

@@ -1,58 +0,0 @@
----
-name: Parse command-line arguments
----
-
-The _argument vector_ is the list of arguments passed to the program when it is run. It is available as `Bun.argv`.
-
-```ts#cli.ts
-console.log(Bun.argv);
-```
-
----
-
-Running this file with arguments results in the following:
-
-```sh
-$ bun run cli.ts --flag1 --flag2 value
-[ '/path/to/bun', '/path/to/cli.ts', '--flag1', '--flag2', 'value' ]
-```
-
----
-
-To parse `argv` into a more useful format, `util.parseArgs` would be helpful.
-
-Example:
-
-```ts#cli.ts
-import { parseArgs } from "util";
-
-const { values, positionals } = parseArgs({
-  args: Bun.argv,
-  options: {
-    flag1: {
-      type: 'boolean',
-    },
-    flag2: {
-      type: 'string',
-    },
-  },
-  strict: true,
-  allowPositionals: true,
-});
-
-console.log(values);
-console.log(positionals);
-```
-
----
-
-then it outputs
-
-```sh
-$ bun run cli.ts --flag1 --flag2 value
-{
-  flag1: true,
-  flag2: "value",
-}
-[ "/path/to/bun", "/path/to/cli.ts" ]
-```

package/docs/guides/process/ctrl-c.md

@@ -1,16 +0,0 @@
----
-name: Listen for CTRL+C
----
-
-The `ctrl+c` shortcut sends an _interrupt signal_ to the running process. This signal can be intercepted by listening for the `SIGINT` event. If you want to close the process, you must explicitly call `process.exit()`.
-
-```ts
-process.on("SIGINT", () => {
-  console.log("Ctrl-C was pressed");
-  process.exit();
-});
-```
-
----
-
-See [Docs > API > Utils](https://bun.com/docs/api/utils) for more useful utilities.

package/docs/guides/process/ipc.md

@@ -1,66 +0,0 @@
----
-name: Spawn a child process and communicate using IPC
----
-
-Use [`Bun.spawn()`](https://bun.com/docs/api/spawn) to spawn a child process. When spawning a second `bun` process, you can open a direct inter-process communication (IPC) channel between the two processes.
-
-{%callout%}
-**Note** — This API is only compatible with other `bun` processes. Use `process.execPath` to get a path to the currently running `bun` executable.
-{%/callout%}
-
-```ts#parent.ts
-const child = Bun.spawn(["bun", "child.ts"], {
-  ipc(message) {
-    /**
-     * The message received from the sub process
-     **/
-  },
-});
-```
-
----
-
-The parent process can send messages to the subprocess using the `.send()` method on the returned `Subprocess` instance. A reference to the sending subprocess is also available as the second argument in the `ipc` handler.
-
-```ts#parent.ts
-const childProc = Bun.spawn(["bun", "child.ts"], {
-  ipc(message, childProc) {
-    /**
-     * The message received from the sub process
-     **/
-    childProc.send("Respond to child")
-  },
-});
-
-childProc.send("I am your father"); // The parent can send messages to the child as well
-```
-
----
-
-Meanwhile the child process can send messages to its parent using with `process.send()` and receive messages with `process.on("message")`. This is the same API used for `child_process.fork()` in Node.js.
-
-```ts#child.ts
-process.send("Hello from child as string");
-process.send({ message: "Hello from child as object" });
-
-process.on("message", (message) => {
-  // print message from parent
-  console.log(message);
-});
-```
-
----
-
-All messages are serialized using the JSC `serialize` API, which allows for the same set of [transferrable types](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Transferable_objects) supported by `postMessage` and `structuredClone`, including strings, typed arrays, streams, and objects.
-
-```ts#child.ts
-// send a string
-process.send("Hello from child as string");
-
-// send an object
-process.send({ message: "Hello from child as object" });
-```
-
----
-
-See [Docs > API > Child processes](https://bun.com/docs/api/spawn) for complete documentation.

package/docs/guides/process/nanoseconds.md

@@ -1,13 +0,0 @@
----
-name: Get the process uptime in nanoseconds
----
-
-Use `Bun.nanoseconds()` to get the total number of nanoseconds the `bun` process has been alive.
-
-```ts
-Bun.nanoseconds();
-```
-
----
-
-See [Docs > API > Utils](https://bun.com/docs/api/utils) for more useful utilities.

package/docs/guides/process/os-signals.md

@@ -1,39 +0,0 @@
----
-name: Listen to OS signals
----
-
-Bun supports the Node.js `process` global, including the `process.on()` method for listening to OS signals.
-
-```ts
-process.on("SIGINT", () => {
-  console.log("Received SIGINT");
-});
-```
-
----
-
-If you don't know which signal to listen for, you listen to the umbrella `"exit"` event.
-
-```ts
-process.on("exit", code => {
-  console.log(`Process exited with code ${code}`);
-});
-```
-
----
-
-If you don't know which signal to listen for, you listen to the [`"beforeExit"`](https://nodejs.org/api/process.html#event-beforeexit) and [`"exit"`](https://nodejs.org/api/process.html#event-exit) events.
-
-```ts
-process.on("beforeExit", code => {
-  console.log(`Event loop is empty!`);
-});
-
-process.on("exit", code => {
-  console.log(`Process is exiting with code ${code}`);
-});
-```
-
----
-
-See [Docs > API > Utils](https://bun.com/docs/api/utils) for more useful utilities.

package/docs/guides/process/spawn-stderr.md

@@ -1,31 +0,0 @@
----
-name: Read stderr from a child process
----
-
-When using [`Bun.spawn()`](https://bun.com/docs/api/spawn), the child process inherits the `stderr` of the spawning process. If instead you'd prefer to read and handle `stderr`, set the `stderr` option to `"pipe"`.
-
-```ts
-const proc = Bun.spawn(["echo", "hello"], {
-  stderr: "pipe",
-});
-proc.stderr; // => ReadableStream
-```
-
----
-
-To read `stderr` until the child process exits, use .text()
-
-```ts
-const proc = Bun.spawn(["echo", "hello"], {
-  stderr: "pipe",
-});
-
-const errors: string = await proc.stderr.text();
-if (errors) {
-  // handle errors
-}
-```
-
----
-
-See [Docs > API > Child processes](https://bun.com/docs/api/spawn) for complete documentation.

package/docs/guides/process/spawn-stdout.md

@@ -1,26 +0,0 @@
----
-name: Read stdout from a child process
----
-
-When using [`Bun.spawn()`](https://bun.com/docs/api/spawn), the `stdout` of the child process can be consumed as a `ReadableStream` via `proc.stdout`.
-
-```ts
-const proc = Bun.spawn(["echo", "hello"]);
-
-const output = await proc.stdout.text();
-output; // => "hello"
-```
-
----
-
-To instead pipe the `stdout` of the child process to `stdout` of the parent process, set "inherit".
-
-```ts
-const proc = Bun.spawn(["echo", "hello"], {
-  stdout: "inherit",
-});
-```
-
----
-
-See [Docs > API > Child processes](https://bun.com/docs/api/spawn) for complete documentation.

package/docs/guides/process/spawn.md

@@ -1,41 +0,0 @@
----
-name: Spawn a child process
----
-
-Use [`Bun.spawn()`](https://bun.com/docs/api/spawn) to spawn a child process.
-
-```ts
-const proc = Bun.spawn(["echo", "hello"]);
-
-// await completion
-await proc.exited;
-```
-
----
-
-The second argument accepts a configuration object.
-
-```ts
-const proc = Bun.spawn(["echo", "Hello, world!"], {
-  cwd: "/tmp",
-  env: { FOO: "bar" },
-  onExit(proc, exitCode, signalCode, error) {
-    // exit handler
-  },
-});
-```
-
----
-
-By default, the `stdout` of the child process can be consumed as a `ReadableStream` using `proc.stdout`.
-
-```ts
-const proc = Bun.spawn(["echo", "hello"]);
-
-const output = await proc.stdout.text();
-output; // => "hello\n"
-```
-
----
-
-See [Docs > API > Child processes](https://bun.com/docs/api/spawn) for complete documentation.

package/docs/guides/process/stdin.md

@@ -1,54 +0,0 @@
----
-name: Read from stdin
----
-
-For CLI tools, it's often useful to read from `stdin`. In Bun, the `console` object is an `AsyncIterable` that yields lines from `stdin`.
-
-```ts#index.ts
-const prompt = "Type something: ";
-process.stdout.write(prompt);
-for await (const line of console) {
-  console.log(`You typed: ${line}`);
-  process.stdout.write(prompt);
-}
-```
-
----
-
-Running this file results in a never-ending interactive prompt that echoes whatever the user types.
-
-```sh
-$ bun run index.ts
-Type something: hello
-You typed: hello
-Type something: hello again
-You typed: hello again
-```
-
----
-
-Bun also exposes stdin as a `BunFile` via `Bun.stdin`. This is useful for incrementally reading large inputs that are piped into the `bun` process.
-
-There is no guarantee that the chunks will be split line-by-line.
-
-```ts#stdin.ts
-for await (const chunk of Bun.stdin.stream()) {
-  // chunk is Uint8Array
-  // this converts it to text (assumes ASCII encoding)
-  const chunkText = Buffer.from(chunk).toString();
-  console.log(`Chunk: ${chunkText}`);
-}
-```
-
----
-
-This will print the input that is piped into the `bun` process.
-
-```sh
-$ echo "hello" | bun run stdin.ts
-Chunk: hello
-```
-
----
-
-See [Docs > API > Utils](https://bun.com/docs/api/utils) for more useful utilities.

package/docs/guides/read-file/arraybuffer.md

@@ -1,28 +0,0 @@
----
-name: Read a file to an ArrayBuffer
----
-
-The `Bun.file()` function accepts a path and returns a `BunFile` instance. The `BunFile` class extends `Blob` and allows you to lazily read the file in a variety of formats. Use `.arrayBuffer()` to read the file as an `ArrayBuffer`.
-
-```ts
-const path = "/path/to/package.json";
-const file = Bun.file(path);
-
-const buffer = await file.arrayBuffer();
-```
-
----
-
-The binary content in the `ArrayBuffer` can then be read as a typed array, such as `Int8Array`. For `Uint8Array`, use [`.bytes()`](./uint8array).
-
-```ts
-const buffer = await file.arrayBuffer();
-const bytes = new Int8Array(buffer);
-
-bytes[0];
-bytes.length;
-```
-
----
-
-Refer to the [Typed arrays](https://bun.com/docs/api/binary-data#typedarray) docs for more information on working with typed arrays in Bun.

package/docs/guides/read-file/buffer.md

@@ -1,19 +0,0 @@
----
-name: Read a file to a Buffer
----
-
-The `Bun.file()` function accepts a path and returns a `BunFile` instance. The `BunFile` class extends `Blob` and allows you to lazily read the file in a variety of formats.
-
-To read the file into a `Buffer` instance, first use `.arrayBuffer()` to consume the file as an `ArrayBuffer`, then use `Buffer.from()` to create a `Buffer` from the `ArrayBuffer`.
-
-```ts
-const path = "/path/to/package.json";
-const file = Bun.file(path);
-
-const arrbuf = await file.arrayBuffer();
-const buffer = Buffer.from(arrbuf);
-```
-
----
-
-Refer to [Binary data > Buffer](https://bun.com/docs/api/binary-data#buffer) for more information on working with `Buffer` and other binary data formats in Bun.

package/docs/guides/read-file/exists.md

@@ -1,16 +0,0 @@
----
-name: Check if a file exists
----
-
-The `Bun.file()` function accepts a path and returns a `BunFile` instance. Use the `.exists()` method to check if a file exists at the given path.
-
-```ts
-const path = "/path/to/package.json";
-const file = Bun.file(path);
-
-await file.exists(); // boolean;
-```
-
----
-
-Refer to [API > File I/O](https://bun.com/docs/api/file-io) for more information on working with `BunFile`.

package/docs/guides/read-file/json.md

@@ -1,17 +0,0 @@
----
-name: Read a JSON file
----
-
-The `Bun.file()` function accepts a path and returns a `BunFile` instance. The `BunFile` class extends `Blob` and allows you to lazily read the file in a variety of formats. Use `.json()` to read and parse the contents of a `.json` file as a plain object.
-
-The MIME type of the `BunFile` will be set accordingly.
-
-```ts
-const path = "/path/to/package.json";
-const file = Bun.file(path);
-
-const contents = await file.json();
-// { name: "my-package" }
-
-file.type; // => "application/json;charset=utf-8";
-```

package/docs/guides/read-file/mime.md

@@ -1,20 +0,0 @@
----
-name: Get the MIME type of a file
----
-
-The `Bun.file()` function accepts a path and returns a `BunFile` instance. The `BunFile` class extends `Blob`, so use the `.type` property to read the MIME type.
-
-```ts
-const file = Bun.file("./package.json");
-file.type; // application/json
-
-const file = Bun.file("./index.html");
-file.type; // text/html
-
-const file = Bun.file("./image.png");
-file.type; // image/png
-```
-
----
-
-Refer to [API > File I/O](https://bun.com/docs/api/file-io) for more information on working with `BunFile`.

package/docs/guides/read-file/stream.md

@@ -1,26 +0,0 @@
----
-name: Read a file as a ReadableStream
----
-
-The `Bun.file()` function accepts a path and returns a `BunFile` instance. The `BunFile` class extends `Blob` and allows you to lazily read the file in a variety of formats. Use `.stream()` to consume the file incrementally as a `ReadableStream`.
-
-```ts
-const path = "/path/to/package.json";
-const file = Bun.file(path);
-
-const stream = file.stream();
-```
-
----
-
-The chunks of the stream can be consumed as an [async iterable](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols) using `for await`.
-
-```ts
-for await (const chunk of stream) {
-  chunk; // => Uint8Array
-}
-```
-
----
-
-Refer to the [Streams](https://bun.com/docs/api/streams) documentation for more information on working with streams in Bun.

package/docs/guides/read-file/string.md

@@ -1,22 +0,0 @@
----
-name: Read a file as a string
----
-
-The `Bun.file()` function accepts a path and returns a `BunFile` instance. The `BunFile` class extends `Blob` and allows you to lazily read the file in a variety of formats. Use `.text()` to read the contents as a string.
-
-```ts
-const path = "/path/to/file.txt";
-const file = Bun.file(path);
-
-const text = await file.text();
-// string
-```
-
----
-
-Any relative paths will be resolved relative to the project root (the nearest directory containing a `package.json` file).
-
-```ts
-const path = "./file.txt";
-const file = Bun.file(path);
-```

package/docs/guides/read-file/uint8array.md

@@ -1,21 +0,0 @@
----
-name: Read a file to a Uint8Array
----
-
-The `Bun.file()` function accepts a path and returns a `BunFile` instance. The `BunFile` class extends `Blob` and allows you to lazily read the file in a variety of formats.
-
-To read the file into a `Uint8Array` instance, retrieve the contents of the `BunFile` with `.bytes()`.
-
-```ts
-const path = "/path/to/package.json";
-const file = Bun.file(path);
-
-const byteArray = await file.bytes();
-
-byteArray[0]; // first byteArray
-byteArray.length; // length of byteArray
-```
-
----
-
-Refer to [API > Binary data > Typed arrays](https://bun.com/docs/api/binary-data#typedarray) for more information on working with `Uint8Array` and other binary data formats in Bun.

package/docs/guides/read-file/watch.md

@@ -1,68 +0,0 @@
----
-name: Watch a directory for changes
----
-
-Bun implements the `node:fs` module, including the `fs.watch` function for listening for file system changes.
-
-This code block listens for changes to files in the current directory. By default this operation is _shallow_, meaning that changes to files in subdirectories will not be detected.
-
-```ts
-import { watch } from "fs";
-
-const watcher = watch(import.meta.dir, (event, filename) => {
-  console.log(`Detected ${event} in ${filename}`);
-});
-```
-
----
-
-To listen to changes in subdirectories, pass the `recursive: true` option to `fs.watch`.
-
-```ts
-import { watch } from "fs";
-
-const watcher = watch(
-  import.meta.dir,
-  { recursive: true },
-  (event, relativePath) => {
-    console.log(`Detected ${event} in ${relativePath}`);
-  },
-);
-```
-
----
-
-Using the `node:fs/promises` module, you can listen for changes using `for await...of` instead of a callback.
-
-```ts
-import { watch } from "fs/promises";
-
-const watcher = watch(import.meta.dir);
-for await (const event of watcher) {
-  console.log(`Detected ${event.eventType} in ${event.filename}`);
-}
-```
-
----
-
-To stop listening for changes, call `watcher.close()`. It's common to do this when the process receives a `SIGINT` signal, such as when the user presses Ctrl-C.
-
-```ts
-import { watch } from "fs";
-
-const watcher = watch(import.meta.dir, (event, filename) => {
-  console.log(`Detected ${event} in ${filename}`);
-});
-
-process.on("SIGINT", () => {
-  // close watcher when Ctrl-C is pressed
-  console.log("Closing watcher...");
-  watcher.close();
-
-  process.exit(0);
-});
-```
-
----
-
-Refer to [API > Binary data > Typed arrays](https://bun.com/docs/api/binary-data#typedarray) for more information on working with `Uint8Array` and other binary data formats in Bun.