JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 244308
  • Score
    100M100P100Q177090F
  • License MIT

Use Ky in both Node.js and browsers

Package Exports

  • ky-universal

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ky-universal) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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.

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