Extendable Promise

A promise that can be delayed (extended) via repeated calls to waitUntil.

"Extendable" here refers to the ability to extend the duration of the promise, not inheritance/subtypes/etc. The name and API are modelled after the ExtendableEvent interface that was introduced to the web part of the Service Worker API. As such, it provides a waitUntil method that takes a promise as argument that extends settlement of the parent promise until all promises that were added in this way have settled. You can think about it like Promise.allSettled, except you can add promises to the list after the fact. Example:

const p = new ExtendablePromise(timeout(200).then(() => 1));
await timeout(100)
p.waitUntil(timeout(300).then(() => Promise.reject(Error('2'))));

const res = await p; // total duration ~400ms (100 + 300)

assertEquals(res, [
  { status: "fulfilled", value: 1 },
  { status: "rejected", reason: Error('2') },
]);

After all promises have settled, further calls to waitUntil become no-ops.

The constructor takes a promise as argument, which sets the minimum duration for the extendable promise.

If an extendable promise is created without supplying an initial promise, it is "idle" (awaiting it pauses execution) until the first call to waitUntil "primes" it.

Initializing it with a synchronous value or a settled promise immediately settles the extendable promise with that value and all calls to waitUntil are no-ops.


This module is part of the Worker Tools collection
⁕

Worker Tools are a collection of TypeScript libraries for writing web servers in Worker Runtimes such as Cloudflare Workers, Deno Deploy and Service Workers in the browser.

If you liked this module, you might also like:

  • 🧭 Worker Router --- Complete routing solution that works across CF Workers, Deno and Service Workers
  • πŸ”‹ Worker Middleware --- A suite of standalone HTTP server-side middleware with TypeScript support
  • πŸ“„ Worker HTML --- HTML templating and streaming response library
  • πŸ“¦ Storage Area --- Key-value store abstraction across Cloudflare KV, Deno and browsers.
  • πŸ†— Response Creators --- Factory functions for responses with pre-filled status and status text
  • 🎏 Stream Response --- Use async generators to build streaming responses for SSE, etc...
  • πŸ₯ JSON Fetch --- Drop-in replacements for Fetch API classes with first class support for JSON.
  • πŸ¦‘ JSON Stream --- Streaming JSON parser/stingifier with first class support for web streams.

Worker Tools also includes a number of polyfills that help bridge the gap between Worker Runtimes:

  • ✏️ HTML Rewriter --- Cloudflare's HTML Rewriter for use in Deno, browsers, etc...
  • πŸ“ Location Polyfill --- A Location polyfill for Cloudflare Workers.
  • πŸ¦• Deno Fetch Event Adapter --- Dispatches global fetch events using Deno’s native HTTP server.

Fore more visit workers.tools.