@worker-tools/response-creators
TypeScript icon, indicating that this package has built-in type declarations

1.2.0-pre.6 • Public • Published

Response Creators

A collection of factory functions for Fetch API Response types with pre-filled status and status-text headers for well-known HTTP status codes.

It is meant to be used in Service Workers and/or Cloudflare Workers.

import { ok } from '@worker-tools/response-creators'

self.addEventListener('fetch', event => event.respondWith(ok()))

For the most part, factory functions can be used like regular Response constructors, e.g.

event.respondWith(
  ok('Your custom body init', { headers: { 'Content-Type': 'text/plain' } })
)

However, some provide a slightly different interface for enhanced usability. E.g. redirects (300, 301, 302, 303, 307, 308):

event.respondWith(
  seeOther(`/your-redirect-url`)
)

(This will set the Location header to /your-redirect-url).

NOTE: When using JSON response bodies, consider combining it with worker-tools/json-fetch like so:

event.respondWith(
  new JSONResponse({ error: '...' }, badRequest())
)

Due to signature of the Response constructor, the opposite order (badRequest(new JSONResponse({ error: '...' }))) does not work!


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:

Fore more visit workers.tools.

Package Sidebar

Install

npm i @worker-tools/response-creators

Weekly Downloads

112

Version

1.2.0-pre.6

License

MIT

Unpacked Size

39.7 kB

Total Files

11

Last publish

Collaborators

  • qwtel