bun-types 1.1.43-canary.20250107T145807 → 1.1.43-canary.20250108T140520

package/docs/api/s3.md

@@ -150,7 +150,7 @@ const writer = s3file.writer({
   queueSize: 10,
 
   // Upload in 5 MB chunks
-  partSize: 5,
+  partSize: 5 * 1024 * 1024,
 });
 for (let i = 0; i < 10; i++) {
   await writer.write(bigFile);
@@ -367,7 +367,7 @@ If the `S3_*` environment variable is not set, Bun will also check for the `AWS_
 
 These environment variables are read from [`.env` files](/docs/runtime/env) or from the process environment at initialization time (`process.env` is not used for this).
 
-These defaults are overriden by the options you pass to `s3(credentials)`, `new Bun.S3Client(credentials)`, or any of the methods that accept credentials. So if, for example, you use the same credentials for different buckets, you can set the credentials once in your `.env` file and then pass `bucket: "my-bucket"` to the `s3()` helper function without having to specify all the credentials again.
+These defaults are overridden by the options you pass to `s3(credentials)`, `new Bun.S3Client(credentials)`, or any of the methods that accept credentials. So if, for example, you use the same credentials for different buckets, you can set the credentials once in your `.env` file and then pass `bucket: "my-bucket"` to the `s3()` helper function without having to specify all the credentials again.
 
 ### `S3Client` objects
 
@@ -614,9 +614,10 @@ const credentials = {
 
 const stat = await S3Client.stat("my-file.txt", credentials);
 // {
+//   etag: "\"7a30b741503c0b461cc14157e2df4ad8\"",
+//   lastModified: 2025-01-07T00:19:10.000Z,
 //   size: 1024,
-//   etag: "1234567890",
-//   lastModified: new Date(),
+//   type: "text/plain;charset=utf-8",
 // }
 ```
 
@@ -661,7 +662,7 @@ const response = await fetch("s3://my-bucket/my-file.txt", {
     endpoint: "https://s3.us-east-1.amazonaws.com",
   },
   headers: {
-    "x-amz-meta-foo": "bar",
+    "range": "bytes=0-1023",
   },
 });
 ```

package/docs/api/sqlite.md

@@ -82,7 +82,7 @@ const strict = new Database(
 // throws error because of the typo:
 const query = strict
   .query("SELECT $message;")
-  .all({ messag: "Hello world" });
+  .all({ message: "Hello world" });
 
 const notStrict = new Database(
   ":memory:"
@@ -90,7 +90,7 @@ const notStrict = new Database(
 // does not throw error:
 notStrict
   .query("SELECT $message;")
-  .all({ messag: "Hello world" });
+  .all({ message: "Hello world" });
 ```
 
 ### Load via ES module import

package/docs/api/utils.md

@@ -121,7 +121,7 @@ const id = randomUUIDv7();
 
 A UUID v7 is a 128-bit value that encodes the current timestamp, a random value, and a counter. The timestamp is encoded using the lowest 48 bits, and the random value and counter are encoded using the remaining bits.
 
-The `timestamp` parameter defaults to the current time in milliseconds. When the timestamp changes, the counter is reset to a psuedo-random integer wrapped to 4096. This counter is atomic and threadsafe, meaning that using `Bun.randomUUIDv7()` in many Workers within the same process running at the same timestamp will not have colliding counter values.
+The `timestamp` parameter defaults to the current time in milliseconds. When the timestamp changes, the counter is reset to a pseudo-random integer wrapped to 4096. This counter is atomic and threadsafe, meaning that using `Bun.randomUUIDv7()` in many Workers within the same process running at the same timestamp will not have colliding counter values.
 
 The final 8 bytes of the UUID are a cryptographically secure random value. It uses the same random number generator used by `crypto.randomUUID()` (which comes from BoringSSL, which in turn comes from the platform-specific system random number generator usually provided by the underlying hardware).
 

package/docs/cli/filter.md

@@ -1,4 +1,51 @@
-Use the `--filter` flag to execute lifecycle scripts in multiple packages at once:
+The `--filter` (or `-F`) flag is used for selecting packages by pattern in a monorepo. Patterns can be used to match package names or package paths, with full glob syntax support.
+
+Currently `--filter` is supported by `bun install` and `bun outdated`, and can also be used to run scripts for multiple packages at once.
+
+## Matching
+
+### Package Name `--filter <pattern>`
+
+Name patterns select packages based on the package name, as specified in `package.json`. For example, if you have packages `pkg-a`, `pkg-b` and `other`, you can match all packages with `*`, only `pkg-a` and `pkg-b` with `pkg*`, and a specific package by providing the full name of the package.
+
+### Package Path `--filter ./<glob>`
+
+Path patterns are specified by starting the pattern with `./`, and will select all packages in directories that match the pattern. For example, to match all packages in subdirectories of `packages`, you can use `--filter './packages/**'`. To match a package located in `packages/foo`, use `--filter ./packages/foo`.
+
+## `bun install` and `bun outdated`
+
+Both `bun install` and `bun outdated` support the `--filter` flag.
+
+`bun install` by default will install dependencies for all packages in the monorepo. To install dependencies for specific packages, use `--filter`.
+
+Given a monorepo with workspaces `pkg-a`, `pkg-b`, and `pkg-c` under `./packages`:
+
+```bash
+# Install dependencies for all workspaces except `pkg-c`
+$ bun install --filter '!pkg-c'
+
+# Install dependencies for packages in `./packages` (`pkg-a`, `pkg-b`, `pkg-c`)
+$ bun install --filter './packages/*'
+
+# Save as above, but exclude the root package.json
+$ bun install --filter --filter '!./' --filter './packages/*'
+```
+
+Similarly, `bun outdated` will display outdated dependencies for all packages in the monorepo, and `--filter` can be used to restrict the command to a subset of the packages:
+
+```bash
+# Display outdated dependencies for workspaces starting with `pkg-`
+$ bun outdated --filter 'pkg-*'
+
+# Display outdated dependencies for only the root package.json
+$ bun outdated --filter './'
+```
+
+For more information on both these commands, see [`bun install`](https://bun.sh/docs/cli/install) and [`bun outdated`](https://bun.sh/docs/cli/outdated).
+
+## Running scripts with `--filter`
+
+Use the `--filter` flag to execute scripts in multiple packages at once:
 
 ```bash
 bun --filter <pattern> <script>
@@ -24,19 +71,7 @@ bun --filter '*' dev
 Both commands will be run in parallel, and you will see a nice terminal UI showing their respective outputs:
 ![Terminal Output](https://github.com/oven-sh/bun/assets/48869301/2a103e42-9921-4c33-948f-a1ad6e6bac71)
 
-## Matching
-
-`--filter` accepts a pattern to match specific packages, either by name or by path. Patterns have full support for glob syntax.
-
-### Package Name `--filter <pattern>`
-
-Name patterns select packages based on the package name, as specified in `package.json`. For example, if you have packages `pkga`, `pkgb` and `other`, you can match all packages with `*`, only `pkga` and `pkgb` with `pkg*`, and a specific package by providing the full name of the package.
-
-### Package Path `--filter ./<glob>`
-
-Path patterns are specified by starting the pattern with `./`, and will select all packages in directories that match the pattern. For example, to match all packages in subdirectories of `packages`, you can use `--filter './packages/**'`. To match a package located in `pkgs/foo`, use `--filter ./pkgs/foo`.
-
-## Workspaces
+### Running scripts in workspaces
 
 Filters respect your [workspace configuration](https://bun.sh/docs/install/workspaces): If you have a `package.json` file that specifies which packages are part of the workspace,
 `--filter` will be restricted to only these packages. Also, in a workspace you can use `--filter` to run scripts in packages that are located anywhere in the workspace:
@@ -50,8 +85,6 @@ Filters respect your [workspace configuration](https://bun.sh/docs/install/works
 bun run --filter foo myscript
 ```
 
-## Dependency Order
+### Dependency Order
 
 Bun will respect package dependency order when running scripts. Say you have a package `foo` that depends on another package `bar` in your workspace, and both packages have a `build` script. When you run `bun --filter '*' build`, you will notice that `foo` will only start running once `bar` is done.
-
-### Cyclic Dependencies

package/docs/cli/install.md

@@ -81,6 +81,20 @@ Bun supports `"workspaces"` in package.json. For complete documentation refer to
 }
 ```
 
+## Installing dependencies for specific packages
+
+In a monorepo, you can install the dependencies for a subset of packages using the `--filter` flag.
+
+```bash
+# Install dependencies for all workspaces except `pkg-c`
+$ bun install --filter '!pkg-c'
+
+# Install dependencies for only `pkg-a` in `./packages/pkg-a`
+$ bun install --filter './packages/pkg-a'
+```
+
+For more information on filtering with `bun install`, refer to [Package Manager > Filtering](https://bun.sh/docs/cli/install#bun-install-and-bun-outdated)
+
 ## Overrides and resolutions
 
 Bun supports npm's `"overrides"` and Yarn's `"resolutions"` in `package.json`. These are mechanisms for specifying a version range for _metadependencies_—the dependencies of your dependencies. Refer to [Package manager > Overrides and resolutions](https://bun.sh/docs/install/overrides) for complete documentation.

package/docs/cli/outdated.md

@@ -59,3 +59,5 @@ If you want to do the same, but exclude the `./apps/api` workspace:
 ```sh
 $ bun outdated --filter './apps/*' --filter '!./apps/api'
 ```
+
+Refer to [Package Manager > Filtering](https://bun.sh/docs/cli/filter#bun-install-and-bun-outdated) for more information on `--filter`.

package/docs/cli/run.md

@@ -153,7 +153,7 @@ $ bun run --bun vite
 
 ### Filtering
 
-in monorepos containing multiple packages, you can use the `--filter` argument to execute scripts in many packages at once.
+In monorepos containing multiple packages, you can use the `--filter` argument to execute scripts in many packages at once.
 
 Use `bun run --filter <name_pattern> <script>` to execute `<script>` in all packages whose name matches `<name_pattern>`.
 For example, if you have subdirectories containing packages named `foo`, `bar` and `baz`, running
@@ -164,7 +164,7 @@ bun run --filter 'ba*' <script>
 
 will execute `<script>` in both `bar` and `baz`, but not in `foo`.
 
-Find more details in the docs page for [filter](https://bun.sh/docs/cli/filter).
+Find more details in the docs page for [filter](https://bun.sh/docs/cli/filter#running-scripts-with-filter).
 
 ## `bun run -` to pipe code from stdin
 

package/docs/install/lockfile.md

@@ -100,7 +100,7 @@ $ head -n3 bun.lock
   "workspaces": {
 ```
 
-Once `bun.lock` is generated, Bun will use it for all subsequent installs and updates through commands that read and modify the lockfile. If both lockfiles exist, `bun.lock` will be choosen over `bun.lockb`.
+Once `bun.lock` is generated, Bun will use it for all subsequent installs and updates through commands that read and modify the lockfile. If both lockfiles exist, `bun.lock` will be chosen over `bun.lockb`.
 
 Bun v1.2.0 will switch the default lockfile format to `bun.lock`.
 

package/docs/runtime/shell.md

@@ -102,7 +102,7 @@ The default handling of non-zero exit codes can be configured by calling `.nothr
 import { $ } from "bun";
 // shell promises will not throw, meaning you will have to
 // check for `exitCode` manually on every shell command.
-$.nothrow(); // equivilent to $.throws(false)
+$.nothrow(); // equivalent to $.throws(false)
 
 // default behavior, non-zero exit codes will throw an error
 $.throws(true);

package/package.json

@@ -1,5 +1,5 @@
 {
-	"version": "1.1.43-canary.20250107T145807",
+	"version": "1.1.43-canary.20250108T140520",
 	"name": "bun-types",
 	"license": "MIT",
 	"main": "",

package/test.d.ts

@@ -1104,22 +1104,24 @@ declare module "bun:test" {
 		toContainAllValues(expected: unknown): void;
 
 		/**
-     * Asserts that an `object` contain any provided value.
-     *
-     * The value must be an object
-     *
-     * @example
-     * const o = { a: 'foo', b: 'bar', c: 'baz' };
-  `  * expect(o).toContainAnyValues(['qux', 'foo']);
-     * expect(o).toContainAnyValues(['qux', 'bar']);
-     * expect(o).toContainAnyValues(['qux', 'baz']);
-     * expect(o).not.toContainAnyValues(['qux']);
-     * @param expected the expected value
-     */
+		 * Asserts that an `object` contain any provided value.
+		 *
+		 * The value must be an object
+		 *
+		 * @example
+		 * const o = { a: 'foo', b: 'bar', c: 'baz' };
+		 * expect(o).toContainAnyValues(['qux', 'foo']);
+		 * expect(o).toContainAnyValues(['qux', 'bar']);
+		 * expect(o).toContainAnyValues(['qux', 'baz']);
+		 * expect(o).not.toContainAnyValues(['qux']);
+		 * @param expected the expected value
+		 */
 		toContainAnyValues(expected: unknown): void;
 
 		/**
 		 * Asserts that an `object` contains all the provided keys.
+		 *
+		 * @example
 		 * expect({ a: 'foo', b: 'bar', c: 'baz' }).toContainKeys(['a', 'b']);
 		 * expect({ a: 'foo', b: 'bar', c: 'baz' }).toContainKeys(['a', 'b', 'c']);
 		 * expect({ a: 'foo', b: 'bar', c: 'baz' }).not.toContainKeys(['a', 'b', 'e']);