bun-types 1.0.20 → 1.0.21

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bun-types",
-  "version": "1.0.20",
+  "version": "1.0.21",
   "license": "MIT",
   "description": "Type definitions for Bun, an incredibly fast JavaScript runtime",
   "types": "types.d.ts",

package/types.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for bun 1.0.20
+// Type definitions for bun 1.0.21
 // Project: https://github.com/oven-sh/bun
 // Definitions by: Jarred Sumner <https://github.com/Jarred-Sumner>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -2985,6 +2985,11 @@ declare var AbortSignal: typeof globalThis extends {
 declare namespace Bun {
   type ArrayBufferView = TypedArray | DataView;
   type StringOrBuffer = string | NodeJS.TypedArray | ArrayBufferLike;
+  type BlobOrStringOrBuffer =
+    | string
+    | NodeJS.TypedArray
+    | ArrayBufferLike
+    | Blob;
   type PathLike = string | NodeJS.TypedArray | ArrayBufferLike | URL;
 }
 
@@ -4873,6 +4878,45 @@ declare module "bun:sqlite" {
     | Record<string, string | bigint | TypedArray | number | boolean | null>;
 
   export default Database;
+
+  /**
+   * Errors from SQLite have a name `SQLiteError`.
+   *
+   * This class does not exist! It is not a class. It is just a type.
+   *
+   * To check if an `Error` is an SQLiteError, use `error.name === "SQLiteError"`
+   */
+  export interface SQLiteError extends Error {
+    readonly name: "SQLiteError";
+
+    /**
+     * The SQLite3 extended error code
+     *
+     * This corresponds to `sqlite3_extended_errcode`.
+     *
+     * @since v1.0.21
+     */
+    errno: number;
+
+    /**
+     * The name of the SQLite3 error code
+     *
+     * @example
+     * "SQLITE_CONSTRAINT_UNIQUE"
+     *
+     * @since v1.0.21
+     */
+    code?: string;
+
+    /**
+     * The UTF-8 byte offset of the sqlite3 query that failed, if known
+     *
+     * This corresponds to `sqlite3_error_offset`.
+     *
+     * @since v1.0.21
+     */
+    readonly byteOffset: number;
+  }
 }
 
 
@@ -4896,6 +4940,7 @@ declare module "bun:sqlite" {
 declare module "bun" {
   type ArrayBufferView = Bun.ArrayBufferView;
   type StringOrBuffer = Bun.StringOrBuffer;
+  type BlobOrStringOrBuffer = Bun.BlobOrStringOrBuffer;
   type PathLike = Bun.PathLike;
   import { Encoding as CryptoEncoding } from "crypto";
   interface Env {
@@ -7637,7 +7682,7 @@ declare module "bun" {
      *
      * @param data
      */
-    update(data: StringOrBuffer): T;
+    update(data: BlobOrStringOrBuffer): T;
 
     /**
      * Finalize the hash
@@ -7661,7 +7706,7 @@ declare module "bun" {
      * @param hashInto `TypedArray` to write the hash into. Faster than creating a new one each time
      */
     static hash(
-      input: StringOrBuffer,
+      input: BlobOrStringOrBuffer,
       hashInto?: NodeJS.TypedArray,
     ): NodeJS.TypedArray;
 
@@ -7672,7 +7717,7 @@ declare module "bun" {
      *
      * @param encoding `DigestEncoding` to return the hash in
      */
-    static hash(input: StringOrBuffer, encoding: DigestEncoding): string;
+    static hash(input: BlobOrStringOrBuffer, encoding: DigestEncoding): string;
   }
 
   type SupportedCryptoAlgorithms =
@@ -7714,7 +7759,10 @@ declare module "bun" {
      *
      * @param input
      */
-    update(input: StringOrBuffer, inputEncoding?: CryptoEncoding): CryptoHasher;
+    update(
+      input: BlobOrStringOrBuffer,
+      inputEncoding?: CryptoEncoding,
+    ): CryptoHasher;
 
     /**
      * Perform a deep copy of the hasher
@@ -7744,7 +7792,7 @@ declare module "bun" {
      */
     static hash(
       algorithm: SupportedCryptoAlgorithms,
-      input: StringOrBuffer,
+      input: BlobOrStringOrBuffer,
       hashInto?: NodeJS.TypedArray,
     ): NodeJS.TypedArray;
 
@@ -7757,7 +7805,7 @@ declare module "bun" {
      */
     static hash(
       algorithm: SupportedCryptoAlgorithms,
-      input: StringOrBuffer,
+      input: BlobOrStringOrBuffer,
       encoding: DigestEncoding,
     ): string;
 
@@ -9407,7 +9455,9 @@ declare module "bun" {
     constructor(pattern: string);
 
     /**
-     * Scan for files that match this glob pattern. Returns an async iterator.
+     * Scan a root directory recursively for files that match this glob pattern. Returns an async iterator.
+     *
+     * @throws {ENOTDIR} Given root cwd path must be a directory
      *
      * @example
      * ```js
@@ -9428,7 +9478,9 @@ declare module "bun" {
     ): AsyncIterableIterator<string>;
 
     /**
-     * Scan for files that match this glob pattern. Returns an iterator.
+     * Synchronously scan a root directory recursively for files that match this glob pattern. Returns an iterator.
+     *
+     * @throws {ENOTDIR} Given root cwd path must be a directory
      *
      * @example
      * ```js
@@ -10638,6 +10690,20 @@ declare module "bun:test" {
      * @param expected the expected value
      */
     toContain(expected: unknown): void;
+    /**
+     * Asserts that an `object` contains a key.
+     *
+     * The value must be an object
+     *
+     * @example
+     * expect({ a: 'foo', b: 'bar', c: 'baz' }).toContainKey('a');
+     * expect({ a: 'foo', b: 'bar', c: 'baz' }).toContainKey('b');
+     * expect({ a: 'foo', b: 'bar', c: 'baz' }).toContainKey('c');
+     * expect({ a: 'foo', b: 'bar', c: 'baz' }).not.toContainKey('d');
+     *
+     * @param expected the expected value
+     */
+    toContainKey(expected: unknown): void;
     /**
      * Asserts that a value contains and equals what is expected.
      *
@@ -10828,6 +10894,14 @@ declare module "bun:test" {
      * @param expected the expected substring or pattern.
      */
     toMatch(expected: string | RegExp): void;
+    /**
+     * Asserts that a value matches the most recent snapshot.
+     *
+     * @example
+     * expect([1, 2, 3]).toMatchSnapshot('hint message');
+     * @param hint Hint used to identify the snapshot in the snapshot file.
+     */
+    toMatchSnapshot(hint?: string): void;
     /**
      * Asserts that a value matches the most recent snapshot.
      *
@@ -10956,6 +11030,15 @@ declare module "bun:test" {
      * expect(NaN).not.toBeInteger();
      */
     toBeInteger(): void;
+    /**
+     * Asserts that a value is an `object`.
+     *
+     * @example
+     * expect({}).toBeObject();
+     * expect("notAnObject").not.toBeObject();
+     * expect(NaN).not.toBeObject();
+     */
+    toBeObject(): void;
     /**
      * Asserts that a value is a `number`, and is not `NaN` or `Infinity`.
      *