Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

ky-universal

0.5.0 • Public • Published

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.

Related

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

Install

npm i ky-universal

DownloadsWeekly Downloads

123,181

Version

0.5.0

License

MIT

Unpacked Size

5.88 kB

Total Files

6

Last publish

Collaborators

  • avatar