bun-types 1.0.28 → 1.0.29

package/bun.d.ts

@@ -47,6 +47,54 @@ declare module "bun" {
    */
   function which(command: string, options?: { PATH?: string; cwd?: string }): string | null;
 
+  /**
+   * Get the column count of a string as it would be displayed in a terminal.
+   * Supports ANSI escape codes, emoji, and wide characters.
+   *
+   * This is useful for:
+   * - Aligning text in a terminal
+   * - Quickly checking if a string contains ANSI escape codes
+   * - Measuring the width of a string in a terminal
+   *
+   * This API is designed to match the popular "string-width" package, so that
+   * existing code can be easily ported to Bun and vice versa.
+   *
+   * @returns The width of the string in columns
+   *
+   * ## Examples
+   * @example
+   * ```ts
+   * import { stringWidth } from "bun";
+   *
+   * console.log(stringWidth("abc")); // 3
+   * console.log(stringWidth("👩‍👩‍👧‍👦")); // 1
+   * console.log(stringWidth("\u001b[31mhello\u001b[39m")); // 5
+   * console.log(stringWidth("\u001b[31mhello\u001b[39m", { countAnsiEscapeCodes: false })); // 5
+   * console.log(stringWidth("\u001b[31mhello\u001b[39m", { countAnsiEscapeCodes: true })); // 13
+   * ```
+   *
+   */
+  function stringWidth(
+    /**
+     * The string to measure
+     */
+    input: string,
+    options?: {
+      /**
+       * If `true`, count ANSI escape codes as part of the string width. If `false`, ANSI escape codes are ignored when calculating the string width.
+       *
+       * @default false
+       */
+      countAnsiEscapeCodes?: boolean;
+      /**
+       * When it's ambiugous and `true`, count emoji as 2 characters wide. If `false`, emoji are counted as 1 character wide.
+       *
+       * @default false
+       */
+      ambiguousIsNarrow?: boolean;
+    },
+  ): number;
+
   export type ShellFunction = (input: Uint8Array) => Uint8Array;
 
   export type ShellExpression =

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.0.28",
+  "version": "1.0.29",
   "name": "bun-types",
   "license": "MIT",
   "main": "",

package/test.d.ts

@@ -873,6 +873,19 @@ declare module "bun:test" {
      * @param expected the expected value
      */
     toStrictEqual(expected: T): void;
+    /**
+     * Asserts that the value is deep equal to an element in the expected array.
+     *
+     * The value must be an array or iterable, which includes strings.
+     *
+     * @example
+     * expect(1).toBeOneOf([1,2,3]);
+     * expect("foo").toBeOneOf(["foo", "bar"]);
+     * expect(true).toBeOneOf(new Set([true]));
+     *
+     * @param expected the expected value
+     */
+    toBeOneOf(expected: Array<unknown> | Iterable<unknown>): void;
     /**
      * Asserts that a value contains what is expected.
      *