Wrap types in global

Author: max-lt

README.md

@@ -10,6 +10,8 @@ bun add -d @openworkers/workers-types
 
 ## Usage
 
+### Exclusive mode (recommended)
+
 Add to your `tsconfig.json`:
 
 ```json
@@ -20,7 +22,23 @@ Add to your `tsconfig.json`:
 }
 ```
 
-Or use a triple-slash directive:
+This includes only OpenWorkers types and excludes conflicting types (like `@types/node` or `@types/bun`). Best for pure worker projects.
+
+### 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:
+
+```json
+{
+  "compilerOptions": {
+    // no "types" array - all @types/* are included
+  }
+}
+```
+
+### Triple-slash directive
+
+For per-file control:
 
 ```typescript
 /// <reference no-default-lib="true" />
@@ -30,6 +48,7 @@ Or use a triple-slash directive:
 
 ## Structure
 
+- `types/globals.d.ts` - globalThis, self
 - `types/fetch.d.ts` - Request, Response, Headers, fetch
 - `types/url.d.ts` - URL, URLSearchParams
 - `types/streams.d.ts` - ReadableStream, WritableStream

index.d.ts

@@ -1,5 +1,6 @@
 // OpenWorkers Runtime Types
 
+/// <reference path="./types/globals.d.ts" />
 /// <reference path="./types/events.d.ts" />
 /// <reference path="./types/abort.d.ts" />
 /// <reference path="./types/streams.d.ts" />

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openworkers/workers-types",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "description": "TypeScript types for the OpenWorkers runtime",
   "license": "MIT",
   "repository": {

types/abort.d.ts

@@ -1,31 +1,38 @@
 // AbortController API types
 
-/**
- * A signal object that allows you to communicate with an async operation
- * and abort it if required via an AbortController.
- */
-interface AbortSignal extends EventTarget {
-  /** Returns true if the signal has been aborted. */
-  readonly aborted: boolean;
-  /** The reason for aborting, if any. */
-  readonly reason: unknown;
-  /** Throws the abort reason if the signal has been aborted. */
-  throwIfAborted(): void;
-}
+export {};
+
+declare global {
+  /**
+   * A signal object that allows you to communicate with an async operation
+   * and abort it if required via an AbortController.
+   */
+  interface AbortSignal extends EventTarget {
+    /** Returns true if the signal has been aborted. */
+    readonly aborted: boolean;
+
+    /** The reason for aborting, if any. */
+    readonly reason: unknown;
+
+    /** Throws the abort reason if the signal has been aborted. */
+    throwIfAborted(): void;
+  }
+
+  /**
+   * A controller object that allows you to abort one or more async operations.
+   *
+   * @example
+   * ```ts
+   * const controller = new AbortController();
+   * fetch(url, { signal: controller.signal });
+   * controller.abort(); // Cancels the fetch
+   * ```
+   */
+  class AbortController {
+    /** The AbortSignal associated with this controller. */
+    readonly signal: AbortSignal;
 
-/**
- * A controller object that allows you to abort one or more async operations.
- *
- * @example
- * ```ts
- * const controller = new AbortController();
- * fetch(url, { signal: controller.signal });
- * controller.abort(); // Cancels the fetch
- * ```
- */
-declare class AbortController {
-  /** The AbortSignal associated with this controller. */
-  readonly signal: AbortSignal;
-  /** Aborts the associated signal with an optional reason. */
-  abort(reason?: unknown): void;
+    /** Aborts the associated signal with an optional reason. */
+    abort(reason?: unknown): void;
+  }
 }