@depup/bun-types 1.3.11-depup.0

package/docs/typescript.mdx

@@ -0,0 +1,54 @@
+---
+title: TypeScript
+description: Using TypeScript with Bun, including type definitions and compiler options
+---
+
+To install the TypeScript definitions for Bun's built-in APIs, install `@types/bun`.
+
+```zsh terminal icon="terminal"
+bun add -d @types/bun # dev dependency
+```
+
+At this point, you should be able to reference the `Bun` global in your TypeScript files without seeing errors in your editor.
+
+## Suggested `compilerOptions`
+
+Bun supports things like top-level await, JSX, and extensioned `.ts` imports, which TypeScript doesn't allow by default. Below is a set of recommended `compilerOptions` for a Bun project, so you can use these features without seeing compiler warnings from TypeScript.
+
+```json tsconfig.json icon="file-json"
+{
+  "compilerOptions": {
+    // Environment setup & latest features
+    "lib": ["ESNext"],
+    "target": "ESNext",
+    "module": "Preserve",
+    "moduleDetection": "force",
+    "jsx": "react-jsx",
+    "allowJs": true,
+
+    // Bundler mode
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "noEmit": true,
+
+    // Best practices
+    "strict": true,
+    "skipLibCheck": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedIndexedAccess": true,
+    "noImplicitOverride": true,
+
+    // Some stricter flags (disabled by default)
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "noPropertyAccessFromIndexSignature": false
+  }
+}
+```
+
+If you run `bun init` in a new directory, this `tsconfig.json` will be generated for you. (The stricter flags are disabled by default.)
+
+```sh terminal icon="terminal"
+bun init
+```

package/extensions.d.ts

@@ -0,0 +1,40 @@
+declare module "*.txt" {
+  var text: string;
+  export = text;
+}
+
+declare module "*.toml" {
+  var contents: any;
+  export = contents;
+}
+
+declare module "*.yaml" {
+  var contents: any;
+  export = contents;
+}
+
+declare module "*.yml" {
+  var contents: any;
+  export = contents;
+}
+
+declare module "*.jsonc" {
+  var contents: any;
+  export = contents;
+}
+
+declare module "*.json5" {
+  var contents: any;
+  export = contents;
+}
+
+declare module "*/bun.lock" {
+  var contents: import("bun").BunLockFile;
+  export = contents;
+}
+
+declare module "*.html" {
+  var contents: import("bun").HTMLBundle;
+
+  export = contents;
+}

package/fetch.d.ts

@@ -0,0 +1,79 @@
+/*
+ * This file does not declare any global types.
+ *
+ * That should only happen in [./globals.d.ts](./globals.d.ts)
+ * so that our documentation generator can pick it up, as it
+ * expects all globals to be declared in one file.
+ *
+ * This may change in the future, which would be
+ * a nice thing as it would allow us to split up
+ * relevant types into their own files.
+ */
+declare module "bun" {
+  type HeadersInit = string[][] | Record<string, string | ReadonlyArray<string>> | Headers;
+  type BodyInit =
+    | ReadableStream
+    | Bun.XMLHttpRequestBodyInit
+    // Extras that Bun supports:
+    | AsyncIterable<string | ArrayBuffer | ArrayBufferView>
+    | AsyncGenerator<string | ArrayBuffer | ArrayBufferView>
+    | (() => AsyncGenerator<string | ArrayBuffer | ArrayBufferView>);
+
+  namespace __internal {
+    type LibOrFallbackHeaders = LibDomIsLoaded extends true ? {} : import("undici-types").Headers;
+    type LibOrFallbackRequest = LibDomIsLoaded extends true ? {} : import("undici-types").Request;
+    type LibOrFallbackResponse = LibDomIsLoaded extends true ? {} : import("undici-types").Response;
+    type LibOrFallbackResponseInit = LibDomIsLoaded extends true ? {} : import("undici-types").ResponseInit;
+    type LibOrFallbackRequestInit = LibDomIsLoaded extends true
+      ? {}
+      : Omit<import("undici-types").RequestInit, "body" | "headers"> & {
+          body?: Bun.BodyInit | null | undefined;
+          headers?: Bun.HeadersInit | undefined;
+        };
+
+    interface BunHeadersOverride extends LibOrFallbackHeaders {
+      /**
+       * Convert {@link Headers} to a plain JavaScript object.
+       *
+       * About 10x faster than `Object.fromEntries(headers.entries())`
+       *
+       * Called when you run `JSON.stringify(headers)`
+       *
+       * Does not preserve insertion order. Well-known header names are lowercased. Other header names are left as-is.
+       */
+      toJSON(): Record<string, string> & { "set-cookie"?: string[] };
+
+      /**
+       * Get the total number of headers
+       */
+      readonly count: number;
+
+      /**
+       * Get all headers matching the name
+       *
+       * Only supports `"Set-Cookie"`. All other headers are empty arrays.
+       *
+       * @param name - The header name to get
+       *
+       * @returns An array of header values
+       *
+       * @example
+       * ```ts
+       * const headers = new Headers();
+       * headers.append("Set-Cookie", "foo=bar");
+       * headers.append("Set-Cookie", "baz=qux");
+       * headers.getAll("Set-Cookie"); // ["foo=bar", "baz=qux"]
+       * ```
+       */
+      getAll(name: "set-cookie" | "Set-Cookie"): string[];
+    }
+
+    interface BunRequestOverride extends LibOrFallbackRequest {
+      headers: BunHeadersOverride;
+    }
+
+    interface BunResponseOverride extends LibOrFallbackResponse {
+      headers: BunHeadersOverride;
+    }
+  }
+}