https://github.com/kitsonk/xhr

An XMLHttpRequest polyfill for Deno CLI and Deploy 🦕
https://github.com/kitsonk/xhr

deno polyfill xhr

Last synced: 2 months ago
JSON representation

An XMLHttpRequest polyfill for Deno CLI and Deploy 🦕

• Host: GitHub
• URL: https://github.com/kitsonk/xhr
• Owner: kitsonk
• License: mit
• Created: 2021-07-02T03:46:31.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-07T09:52:07.000Z (4 months ago)
• Last Synced: 2024-10-30T00:39:26.932Z (3 months ago)
• Topics: deno, polyfill, xhr
• Language: TypeScript
• Homepage: https://jsr.io/@kitsonk/xhr
• Size: 77.1 KB
• Stars: 25
• Watchers: 3
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# xhr

[![xhr ci](https://github.com/kitsonk/xhr/workflows/ci/badge.svg)](https://github.com/kitsonk/xhr)

A `XMLHttpRequest` polyfill for [Deno CLI](https://deno.land/) and

[Deno Deploy](https://deno.com/deploy/). The main intent is to make code written

for a browser that uses `XMLHttpRequest` to fetch JSON, bytes, or text

asynchronously work with Deno.

> ![WARNING]

> At this stage, this polyfill is very experimental and is not well tested. USE

> AT YOUR OWN RISK. Bug reports are welcome.

This polyfill has several known/intentional limitations from a browser standard

`XMLHttpRequest`:

- It does not handle XML, though the name implies it, nor does it handle HTML

  being treated as a response type `"document"`. This uses the browser's built

  in parser to parse the XML and HTML into a DOM object.

- Sync is not supported (passing `false` to the `async` argument). Most browsers

  have deprecated it in the main thread. Since this polyfill works by calling

  Deno's `fetch()` it is nearly impossible to generate a sync version, plus it

  is a really bad idea to block a thread while waiting for a server response.

  **Don't do it, don't use software that requires it.**

## Usage

Import the module. The module will analyze the global scope, and if

`XMLHttpRequest` and its associated APIs are not defined, it will add them:

```ts

import "jsr:/@kitsonk/xhr";

```

Now, `XMLHttpRequest` should be available in the global scope.

## Types

The built in types for Deno do not include the `XMLHttpRequest` and associated

types, so if you are type checking your code and get errors about them not being

defined, there are a couple of solutions. If your code is generally written for

the browser, you might want to consider

[Targeting Deno and the Browser](https://docs.deno.com/runtime/manual/advanced/typescript/configuration#targeting-deno-and-the-browser)

section of the Deno Manual.

If all you want to do is "polyfill" the types, they are available here under

`./globals.d.ts`. You can either import them like:

```ts

import type {} from "jsr:/@kitsonk/xhr/globals";

```

Or using the triple slash reference like:

```ts

/// 

```

---

Copyright 2021-2024 Kitson P. Kelly. All rights reserved.