@openworkers/workers-types

TypeScript types for the OpenWorkers runtime.

Installation

bun add -d @openworkers/workers-types

Usage

Exclusive mode (recommended)

Add to your tsconfig.json:

{
  "compilerOptions": {
    "lib": ["esnext"],
    "types": ["@openworkers/workers-types"]
  }
}

This includes only OpenWorkers types and excludes conflicting types (like @types/node or @types/bun). Best for pure worker projects. Keep "lib": ["esnext"]: the default lib includes the DOM types, which declare the same globals.

Compatible mode

If you need to mix with Node.js or Bun types, just install the package without configuring types. The types will merge with existing globals:

{
  "compilerOptions": {
    // no "types" array - all @types/* are included
  }
}

Triple-slash directive

For per-file control:

/// <reference no-default-lib="true" />
/// <reference lib="esnext" />
/// <reference types="@openworkers/workers-types" />

TypeScript 6 ignores no-default-lib. With TypeScript 6, also set "lib": ["esnext"] in tsconfig.json.

Structure

• types/globals.d.ts - self
• types/fetch.d.ts - Request, Response, Headers, fetch
• types/url.d.ts - URL, URLSearchParams
• types/streams.d.ts - ReadableStream, WritableStream
• types/crypto.d.ts - Web Crypto API
• types/encoding.d.ts - TextEncoder, TextDecoder, atob, btoa
• types/console.d.ts - Console API
• types/timers.d.ts - setTimeout, setInterval
• types/events.d.ts - Event, EventTarget
• types/abort.d.ts - AbortController, AbortSignal
• types/blob.d.ts - Blob, File, FormData
• types/websocket.d.ts - WebSocket, WebSocketPair
• types/workers.d.ts - ExecutionContext, ScheduledEvent, ExportedHandler
• types/bindings.d.ts - BindingAssets, BindingStorage, BindingKV, BindingDatabase, BindingD1 (D1Database), BindingWorker