# dashing-client

> Send stats to Dashing from node.js.

Latest version **0.0.5** (published 2014-02-05) · 0 weekly downloads

## Install

```sh
npm install dashing-client
pnpm add dashing-client
yarn add dashing-client
bun add dashing-client
```

## Health

**Score 10/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2014-02-05 |
| First published | 2013-09-23 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.6.19 |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| Author | Benbria |
| Maintainers | jwalton |
| Keywords | dashing, dashboard |

## Links

- npm: https://www.npmjs.com/package/dashing-client
- Repository: https://github.com/benbria/dashing-client
- Issues: https://github.com/benbria/dashing-client/issues
- npm.io page: https://npm.io/package/dashing-client

## Dependencies (1)

- [request](https://npm.io/package/request.md) ~2.33.0

## Recent versions

- 0.0.5 (latest) — 2014-02-05
- 0.0.4 — 2013-12-05
- 0.0.3 — 2013-11-28
- 0.0.2 — 2013-11-08
- 0.0.1 — 2013-09-23

## README

Benbria DashingClient
======================

Sends stats to [Dashing](http://shopify.github.io/dashing/).

Contents
--------

* [What it Does](#what-it-does)
* [Installation](#installation-and-a-quick-intro)


What it Does
------------

DashingClient sends stats to Dashing, the exceptionally handsome dashboard framework.

In much the same way that you can send data from the command line using curl:

    curl -d '{ "auth_token": "YOUR_AUTH_TOKEN", "text": "Hey, Look what I can do!" }'\
    \http://localhost:3030/widgets/welcome

You can send data using DashingClient from your node.js program:

    DashingClient = require('dashing-client');

    dashing = new DashingClient("http://localhost:3030", "YOUR_AUTH_TOKEN");
    dashing.send("welcome", {text: "Hey, look what I can do!"}, function(err, resp, body) {
        // Do callback stuff
    });

Note that you can also pass authentication credentials for basic_auth:

    DashingClient = require('dashing-client');

    dashing = new DashingClient("http://localhost:3030", "YOUR_AUTH_TOKEN",
      {auth: {user: "user", pass: "secret"}});


Installation
------------

Install with:

    npm install dashing-client

Or, add to your package.json

    "dependencies": {
      "dashing-client": ">=0.0.1"
    }

---
_Source: https://npm.io/package/dashing-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._