Hoss NPM | npm.io

Hoss Javascript Agent

This is the Hoss Agent for NodeJS/Browser. The Agent will capture your outbound calls to 3rd party API and let you know when things aren't working. Sign up at https://hoss.com for a free account.

Installation

$ npm i hoss

Prerequisites

Hoss account and API Key
Node 8.10 or higher

Getting started

Put the following snippet of code, ideally at the top of your program:

ES2015 module import:

import hoss from 'hoss';

hoss(YOUR_API_KEY);

CommonJS module require:

const hoss = require('hoss');

hoss(YOUR_API_KEY);

AMD module require:

require(['hoss'], function (hoss) {
  // ...
  hoss(YOUR_API_KEY);
});

You also can use the agent in the browser by loading it via a script tag:

<!DOCTYPE html>
<html>
  <head>
    <script
      src="https://cdn.hoss.com/latest/bundle.min.js"
      crossorigin="anonymous"
    ></script>

    <script>
      // Property in the window object
      window.hoss(YOUR_API_KEY);
    </script>
  </head>
</html>

Options

Option	Type	Description	Default
`hossServerURL`	`String`	Hoss Server
`hossEventApiPath`	`String`	Hoss server path
`hossApiURL`	`String`	Hoss API Url
`remoteConfigEnabled`	`Boolean`	Enable or disable remote configuration fetching	`true`
`remoteConfigInterval`	`Integer`	Time interval in milliseconds to fetch remote configuration	`300000`