@worker-tools/location-polyfill

Version:

A Location polyfill for Cloudflare Workers.

71 lines (53 loc) • 3.86 kB

Markdown

# Location Polyfill A [`Location`](https://developer.mozilla.org/docs/Web/API/Window/location) polyfill for Cloudflare Workers. ## Usage Import the polyfill in your application code. Make sure it's included at the top, before any other dependencies that register `fetch` event listeners. ```ts import '@worker-tools/location-polyfill'; ``` This will populate the global `location` field with the `url` field from incoming requests. In CF Workers, this will typically be your script's `workers.dev` address. *Note that the `location` field will be overwritten with each request!* This is because I haven't been able to find a way to access the worker's URL outside a `fetch` event context. Let me know if there's a better way! To avoid sniffing the url from every request, you can provide the location via a global variable called `WORKER_LOCATION`. In CF Workers, add the following to your `wrangler.toml` to define this variable. ```toml [vars] WORKER_LOCATION = 'http://localhost:8787' ``` -------- <a href="https://workers.tools"><img src="https://workers.tools/assets/img/logo.svg" width="100" height="100" /></a> This module is part of the Worker Tools collection ⁕ [Worker Tools](https://workers.tools) are a collection of TypeScript libraries for writing web servers in [Worker Runtimes](https://workers.js.org) such as Cloudflare Workers, Deno Deploy and Service Workers in the browser. If you liked this module, you might also like: - 🧭 [__Worker Router__][router] --- Complete routing solution that works across CF Workers, Deno and Service Workers - 🔋 [__Worker Middleware__][middleware] --- A suite of standalone HTTP server-side middleware with TypeScript support - 📄 [__Worker HTML__][html] --- HTML templating and streaming response library - 📦 [__Storage Area__][kv-storage] --- Key-value store abstraction across [Cloudflare KV][cloudflare-kv-storage], [Deno][deno-kv-storage] and browsers. - 🆗 [__Response Creators__][response-creators] --- Factory functions for responses with pre-filled status and status text - 🎏 [__Stream Response__][stream-response] --- Use async generators to build streaming responses for SSE, etc... - 🥏 [__JSON Fetch__][json-fetch] --- Drop-in replacements for Fetch API classes with first class support for JSON. - 🦑 [__JSON Stream__][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__][html-rewriter] --- Cloudflare's HTML Rewriter for use in Deno, browsers, etc... - 📍 [__Location Polyfill__][location-polyfill] --- A `Location` polyfill for Cloudflare Workers. - 🦕 [__Deno Fetch Event Adapter__][deno-fetch-event-adapter] --- Dispatches global `fetch` events using Deno’s native HTTP server. [router]: https://workers.tools/router [middleware]: https://workers.tools/middleware [html]: https://workers.tools/html [kv-storage]: https://workers.tools/kv-storage [cloudflare-kv-storage]: https://workers.tools/cloudflare-kv-storage [deno-kv-storage]: https://workers.tools/deno-kv-storage [kv-storage-polyfill]: https://workers.tools/kv-storage-polyfill [response-creators]: https://workers.tools/response-creators [stream-response]: https://workers.tools/stream-response [json-fetch]: https://workers.tools/json-fetch [json-stream]: https://workers.tools/json-stream [request-cookie-store]: https://workers.tools/request-cookie-store [extendable-promise]: https://workers.tools/extendable-promise [html-rewriter]: https://workers.tools/html-rewriter [location-polyfill]: https://workers.tools/location-polyfill [deno-fetch-event-adapter]: https://workers.tools/deno-fetch-event-adapter Fore more visit [workers.tools](https://workers.tools).