gas-fetch-polyfill

This is a polyfill for the fetch API on Google Apps Script. This polyfill is forked from github/fetch and modified to work on Google Apps Script.

The compitability of fetch-google-apps-script-ponyfill is not good enough for me, so I created this polyfill.

Installation

``bash
npm install gas-fetch-polyfill
`

Usage

`javascript
import 'gas-fetch-polyfill';

await fetch('https://example.com');
`

You can also use this as a ponyfill.

`javascript
import { fetch } from 'gas-fetch-polyfill/ponyfill';

await fetch('https://example.com');
`

Example

This polyfill makes it possible to use Hono Client on Google Apps Script.

`typescript
import 'gas-fetch-polyfill';
import { hc } from 'hono/client';
import type { AppType } from './server';

export const client = hc(
'https://example.com',
{ fetch }
);

`

Why gas-fetch-polyfill is bundled?

Most libraries are not bundled with their dependencies, but gas-fetch-polyfill is bundled with its dependencies. This is because the dependencies of gas-fetch-polyfill (abort-controller and event-target-shim) are not supported exports and module fields in package.json.

I bundled this so that there is no need to do any special configuration.

Compatibilities

Request
| | Status | Remarks |
| --------------------------------------- | ------------------ | ---------------------------------------------------------------------------------- |
| Request() constructor | :white_check_mark: | |
| Request.prototype.body | :x: | ReadableStream is not supported on GAS |
| Request.prototype.bodyUsed | :white_check_mark: | |
| Request.prototype.cache | :x: | |
| Request.prototype.credentials | :x: | |
| Request.prototype.destination | :x: | |
| Request.prototype.headers | :white_check_mark: | |
| Request.prototype.integrity | :x: | |
| Request.prototype.isHistoryNavigation | :x: | |
| Request.prototype.keepalive | :x: | |
| Request.prototype.method | :white_check_mark: | Normalize to lowercase |
| Request.prototype.mode | :x: | |
| Request.prototype.redirect | :x: | |
| Request.prototype.referrer | :x: | |
| Request.prototype.referrerPolicy | :x: | |
| Request.prototype.signal | :white_check_mark: | |
| Request.prototype.url | :white_check_mark: | |
| Request.prototype.arrayBuffer() | :white_check_mark: | |
| Request.prototype.blob() | :warning: | Retuning GAS Blob |
| Request.prototype.bytes() | :x: | |
| Request.prototype.clone() | :white_check_mark: | |
| Request.prototype.formData() | :x: | |
| Request.prototype.json() | :white_check_mark: | |
| Request.prototype.text() | :white_check_mark: | |

Response
| | Status | Remarks |
| ---------------------------------- | ------------------ | ---------------------------------------------------------------------------------- |
| Response() constructor | :white_check_mark: | |
| Response.error() | :white_check_mark: | type is "error" |
| Response.json() | :x: | |
| Response.redirect() | :white_check_mark: | |
| Response.prototype.body | :x: | ReadableStream is not supported on GAS |
| Response.prototype.bodyUsed | :white_check_mark: | |
| Response.prototype.headers | :white_check_mark: | |
| Reponse.prototype.ok | :white_check_mark: | |
| Response.prototype.redirected | :white_check_mark: | |
| Response.prototype.status | :white_check_mark: | |
| Response.prototype.statusText | :white_check_mark: | |
| Response.prototype.type | :warning: | Always be "default" |
| Response.prototype.url | :white_check_mark: | |
| Response.prototype.arrayBuffer() | :white_check_mark: | |
| Response.prototype.blob() | :warning: | Retuning GAS Blob |
| Response.prototype.bytes() | :x: | |
| Response.prototype.clone() | :white_check_mark: | |
| Response.prototype.formData() | :x: | |
| Response.prototype.json() | :white_check_mark: | |
| Response.prototype.text() | :white_check_mark: | |

Headers
| | Status | Remarks |
| ----------------------------------------- | ------------------ | ------- |
| Headers() constructor | :white_check_mark: | |
| [Symbol.iterator] | :white_check_mark: | |
| Headers.prototype.append() | :white_check_mark: | |
| Headers.prototype.delete() | :white_check_mark: | |
| Headers.prototype.entries() | :white_check_mark: | |
| Headers.prototype.forEach() | :white_check_mark: | |
| Headers.prototype.get() | :white_check_mark: | |
| Headers.prototype.getSetCookie() | :x: | |
| Headers.prototype.has() | :white_check_mark: | |
| Iteration combines duplicate header names | :white_check_mark: | |
| Iteration is lexicographically sorted | :x: | |
| Headers.prototype.keys() | :white_check_mark: | |
| Headers.prototype.set() | :white_check_mark: | |
| Headers.prototype.values() | :white_check_mark: | |

URL
| | Status | Remarks |
| ---------------------------- | ------------------ | ------- |
| URL() constructor | :white_check_mark: | |
| URL.parse() | :x: | |
| URL.canParse() | :x: | |
| URL.createObjectURL() | :x: | |
| URL.revokeObjectURL() | :x: | |
| URL.prototype.hash | :white_check_mark: | |
| URL.prototype.host | :x: | |
| URL.prototype.hostname | :white_check_mark: | |
| URL.prototype.href | :white_check_mark: | |
| URL.prototype.origin | :white_check_mark: | |
| URL.prototype.password | :white_check_mark: | |
| URL.prototype.pathname | :white_check_mark: | |
| URL.prototype.port | :white_check_mark: | |
| URL.prototype.protocol | :white_check_mark: | |
| URL.prototype.search | :white_check_mark: | |
| URL.prototype.searchParams | :x: | |
| URL.prototype.username | :x: | |
| URL.prototype.toJSON() | :x: | |
| URL.prototype.toString() | :white_check_mark: | |

URLSearchParams
| | Status | Remarks |
| -------------------------------------- | ------------------ | ------- |
| URLSearchParams() constructor | :white_check_mark: | |
| URLSearchParams.prototype.size | :x: | |
| URLSearchParams.prototype.append() | :white_check_mark: | |
| URLSearchParams.prototype.delete() | :white_check_mark: | |
| URLSearchParams.prototype.entries() | :white_check_mark: | |
| URLSearchParams.prototype.forEach() | :white_check_mark: | |
| URLSearchParams.prototype.get() | :white_check_mark: | |
| URLSearchParams.prototype.getAll() | :white_check_mark: | |
| URLSearchParams.prototype.has() | :white_check_mark: | |
| URLSearchParams.prototype.keys() | :white_check_mark: | |
| URLSearchParams.prototype.set() | :white_check_mark: | |
| URLSearchParams.prototype.sort() | :x: | |
| URLSearchParams.prototype.values() | :white_check_mark: | |
| URLSearchParams.prototype.toString() | :white_check_mark: | |

AbortController
AbortController and AbortSignal are implemented using the mysticatea/abort-controller.

| | Status | Remarks |
| ----------------------------------- | ------------------ | ------- |
| AbortController() constructor | :white_check_mark: | |
| AbortController.prototype.signal | :white_check_mark: | |
| AbortController.prototype.abort() | :white_check_mark: | |

AbortSignal
| | Status | Remarks |
| --------------------------------------------- | ------------------ | ------- |
| AbortSignal.abort() | :x: | |
| AbortSignal.any() | :x: | |
| AbortSignal.timeout() | :x: | |
| AbortSignal.prototype.aborted | :white_check_mark: | |
| AbortSignal.prototype.reason | :x: | |
| AbortSignal.prototype.onabort | :white_check_mark: | |
| AbortSignal.prototype.addEventListener() | :white_check_mark: | |
| AbortSignal.prototype.removeEventListener() | :white_check_mark: | |
| AbortSignal.prototype.dispatchEvent() | :white_check_mark: | |
| AbortSignal.prototype.throwIfAborted()` | :x: | |

License

MIT

src/fetch.ts is based on github/fetch and is licensed under MIT.

The bundled code includes abort-controller and event-target-shim. They are licensed under MIT.