alexfigliolia / beaconer

A backward compatible wrapper around the Beacon API

Beaconer

A backward compatible wrapper around the Beacon API!

This API is commonly used for sending application analytics or diagnostics that were historically sent in the background using some combination of standard HTTP Requests with the page visibility API. A common pitfall developers would run into is that the browser, in some cases, would choose not to send out the request when a browser tab is in the background. The Beacon API was implemented to fix this issue.

This package wraps the API with an XMLHttpRequest fallback.

Installation

npm i -S beaconer

yarn add beaconer

Usage

The Beaconer has two public properties:

import { Beaconer } from "beaconer";

const success = await Beaconer.send("url", JSON.stringify({ someData: 123 }));

const isUsingBeaconAPI = Beaconer.browserSupport;