commit

node_modules/ky-universal/readme.md

@@ -0,0 +1,120 @@
+# ky-universal [![Build Status](https://travis-ci.com/sindresorhus/ky-universal.svg?branch=master)](https://travis-ci.com/sindresorhus/ky-universal)
+
+> Use Ky in both Node.js and browsers
+
+[Ky](https://github.com/sindresorhus/ky) is made for browsers, but this package makes it possible to use it in Node.js too, by polyfilling most of the required browser APIs using [`node-fetch`](https://github.com/bitinn/node-fetch) and [`abort-controller`](https://github.com/mysticatea/abort-controller).
+
+This package can be useful for:
+- Isomorphic code
+- Web apps (React, Vue.js, etc.) that use server-side rendering (SSR)
+- Testing browser libraries using a Node.js test runner
+
+**Note:** Before opening an issue, make sure it's an issue with Ky and not its polyfills. Generally, if something works in the browser, but not in Node.js, it's an issue with `node-fetch` or `abort-controller`.
+
+Keep in mind that Ky targets [modern browsers](https://github.com/sindresorhus/ky#browser-support) when used in the browser. For older browsers, you will need to transpile and use a [`fetch` polyfill](https://github.com/github/fetch).
+
+**If you only target Node.js, I would strongly recommend using [Got](https://github.com/sindresorhus/got) instead.**
+
+## Install
+
+```
+$ npm install ky ky-universal
+```
+
+*Note that you also need to install `ky`.*
+
+## Usage
+
+```js
+const ky = require('ky-universal');
+
+(async () => {
+	const parsed = await ky('https://httpbin.org/json').json();
+
+	// …
+})();
+```
+
+## `ReadableStream` support
+
+For [`ReadableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream) support, also install [`web-streams-polyfill`](https://github.com/MattiasBuelens/web-streams-polyfill):
+
+```
+$ npm install web-streams-polyfill
+```
+
+You can then use it normally:
+
+```js
+const ky = require('ky-universal');
+
+(async () => {
+	const {body} = await ky('https://httpbin.org/bytes/16');
+	const {value} = await body.getReader().read();
+	const result = new TextDecoder('utf-8').decode(value);
+
+	// …
+})();
+```
+
+## API
+
+The API is exactly the same as the [Ky API](https://github.com/sindresorhus/ky#api).
+
+## FAQ
+
+#### How do I use this with a web app (React, Vue.js, etc.) that uses server-side rendering (SSR)?
+
+Use it like you would use Ky:
+
+```js
+import ky from 'ky-universal';
+
+(async () => {
+	const parsed = await ky('https://httpbin.org/json').json();
+
+	// …
+})();
+```
+
+Webpack will ensure the polyfills are only included and used when the app is rendered on the server-side.
+
+#### How do I test a browser library that uses Ky in AVA?
+
+Put the following in package.json:
+
+```json
+{
+	"ava": {
+		"require": [
+			"ky-universal"
+		]
+	}
+}
+```
+
+The library that uses Ky will now *just work* in AVA tests.
+
+#### `clone()` hangs with a large response in Node - What should I do?
+
+Streams in Node.js have a smaller internal buffer size (16 kB, aka `highWaterMark`) than browsers (>1 MB, not consistent across browsers). When using Ky, the default `highWaterMark` is set to 10 MB, so you shouldn't encounter many issues related to that.
+
+However, you can specify a custom `highWaterMark` if needed:
+
+```js
+import ky from 'ky-universal';
+
+(async () => {
+	const response = await ky('https://example.com', {
+		// 20 MB
+		highWaterMark: 1000 * 1000 * 20
+	});
+
+	const data = await response.clone().buffer();
+})();
+```
+
+## Related
+
+- [ky](https://github.com/sindresorhus/ky) - Tiny and elegant HTTP client based on the browser Fetch API
+- [got](https://github.com/sindresorhus/got) - Simplified HTTP requests in Node.js