npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@building-block/xhr-fetch

v1.0.0-alpha.8

Published

XHR-powered fetch implementation with upload and download updates

Downloads

98

Readme

xhr-fetch

XHR-powered fetch implementation with extras

NPM Gzip Size

Although fetch is a relatively low-level API and in most cases more complete than XMLHttpRequest, it does not provide an API for request progression. A proposal for FetchObserver is being worked on but currently it is not possible to implement request progression using just fetch.

xhr-fetch provides a fetch-like interface, enough to make it a viable replacement for XMLHttpRequest, that also implements a non-standard request and response progression API.

If response progression is all you need, fetch does provide a low-level API for response progression. In that case we recommend that you stick with the standards unless you prefer a higher level abstraction.

Installation

Using npm:

$ npm install --save @building-block/xhr-fetch

Using yarn:

$ yarn add @building-block/xhr-fetch

Usage

import xhrFetch from '@building-block/xhr-fetch';

xhrFetch('https://postman-echo.com/put', {
  method: 'PUT',
  headers: { /* headers */ },
  body: { /* body */ },
  onDownloadProgress = (xhrEvent) => {
    console.log('Upload progression', xhrEvent);
  },
  onUploadProgress = (xhrEvent) => {
    console.log('Download progression', xhrEvent);
  },
});

Try with Runkit

Tracking progress

To provide a better user experience, you might want to display progression over time such as bitrate (speed), remaining time, transferred bytes, and overall transfer progress, you can use @building-block/track-progress.

Caveats

Aborting requests

xhr-fetch supports the abortable fetch API. This feature requires that you include additional polyfills for AbortController, AbortSignal and DOMException.

import xhrFetch from '@building-block/xhr-fetch';

const abortController = new AbortController();

xhrFetch('/endpoint', {
  signal: abortController.signal,
}).catch((error) => {
  if (error.name === 'AbortError') {
    console.log('Aborted');
  }
});

abortController.abort();

Looking for a fetch polyfill?

This package is not meant to replace fetch. If you're looking for a fetch polyfill, you should use whatwg-fetch. If you are looking to use fetch in Node.js, you can with node-fetch. In universal environments, you can replace whatwg-fetch and node-fetch with just cross-fetch.