ky-universal

Use Ky in both Node.js and browsers

Github stars Tracking Chart

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

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

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

	// …
})();

ReadableStream support

For ReadableStream support, also install web-streams-polyfill:

$ npm install web-streams-polyfill

You can then use it normally:

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.

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.

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

Main metrics

Overview
Name With Ownersindresorhus/ky-universal
Primary LanguageJavaScript
Program languageJavaScript (Language Count: 2)
Platform
License:MIT License
所有者活动
Created At2019-02-22 16:39:06
Pushed At2023-09-01 21:26:23
Last Commit At
Release Count18
Last Release Namev0.12.0 (Posted on 2023-07-28 20:54:05)
First Release Namev0.1.0 (Posted on 2019-02-22 23:48:26)
用户参与
Stargazers Count673
Watchers Count5
Fork Count20
Commits Count46
Has Issues Enabled
Issues Count38
Issue Open Count2
Pull Requests Count8
Pull Requests Open Count0
Pull Requests Close Count2
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private