npm

Bring the best of OSS JavaScript development to your projects with npm Orgs - private packages & team management tools.Learn more »

beacon-agent

0.0.6 • Public • Published

Build Status

Beacon Agent

Simple library that allows you to send events to your server. Useful to send analytics and diagnostics events.

Uses Beacon API if it"s available and an image node if it"s not.

Usage

var tracker = new BeaconAgent("https://tracking.example.com");
tracker.track(eventType: "event", eventCategory: "ad", eventAction: "click", 
  eventData: {adID: "233925", adPosition: "top-left"}
);

Track returns a promise so you can chain it with other async methods:

tracker.track(...).then(console.log("sent analytics event successfully"));

You can also specify a timeout after which the promise will be rejected. This is done to not keep open connections to busy servers forever.

// reject after 5 seconds
var tracker = new Tracker("https://tracking.example.com", 5000); 
tracker.track(...);

Tracker will use these values for the params:

eventType: et
eventCategory: ec
eventAction: ea
eventData: ed

Any unknown param will be transferred "as-is", i.e. "unmodified.

Licence

This code is MIT licenced:

Copyright (c) 2018-2019 Valentin Vasilyev

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

install

npm i beacon-agent

Downloadsweekly downloads

6

version

0.0.6

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability