Skip to content
Use Ky in both Node.js and browsers
Branch: master
Clone or download
Latest commit 41288bd Apr 19, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.editorconfig Init Feb 22, 2019
.gitattributes Init Feb 22, 2019
.gitignore Init Feb 22, 2019
.npmrc Init Feb 22, 2019
.travis.yml Re-enable support for Node.js 8 and require Ky >=0.10.0 Apr 19, 2019
browser.js Init Feb 22, 2019
index.d.ts Init Feb 22, 2019
index.js Re-enable support for Node.js 8 and require Ky >=0.10.0 Apr 19, 2019
license Init Feb 22, 2019
package.json 0.2.0 Apr 19, 2019
readme.md Update readme.md (#1) Feb 23, 2019
test.js Init Feb 22, 2019

readme.md

ky-universal Build Status

Use Ky in both Node.js and browsers

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 and 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 when used in the browser. For older browsers, you will need to transpile and use a fetch polyfill.

If you only target Node.js, I would strongly recommend using Got instead.

Install

$ npm install ky ky-universal

Note that you also need to install ky.

Usage

Use it like you would use Ky:

const ky = require('ky-universal');

(async () => {
	const parsed = await ky('https://httpbin.org/json').json();

	//
})();

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:

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:

{
	"ava": {
		"require": [
			"ky-universal"
		]
	}
}

The library that uses Ky will now just work in AVA tests.

Related

  • ky - Tiny and elegant HTTP client based on the browser Fetch API
  • got - Simplified HTTP requests in Node.js

License

MIT © Sindre Sorhus

You can’t perform that action at this time.