# clickshare-utils

> An unofficial ClickShare utility package for NodeJS

Latest version **0.1.0** (published 2018-01-04) · ISC license · 0 weekly downloads

## Install

```sh
npm install clickshare-utils
pnpm add clickshare-utils
yarn add clickshare-utils
bun add clickshare-utils
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2018-01-04 |
| First published | 2018-01-04 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Michael Vanderheeren |
| Maintainers | michaelvdheeren |

## Links

- npm: https://www.npmjs.com/package/clickshare-utils
- npm.io page: https://npm.io/package/clickshare-utils

## Dependencies (8)

- [lodash](https://npm.io/package/lodash.md) ^4.17.4
- [bonjour](https://npm.io/package/bonjour.md) ^3.5.0
- [connect](https://npm.io/package/connect.md) ^3.4.1
- [request](https://npm.io/package/request.md) ^2.83.0
- [node-ssdp](https://npm.io/package/node-ssdp.md) ^3.2.5
- [http-proxy](https://npm.io/package/http-proxy.md) ^1.13.3
- [lodash-humps](https://npm.io/package/lodash-humps.md) ^3.1.2
- [request-promise](https://npm.io/package/request-promise.md) ^4.2.2

## Recent versions

- 0.1.0 (latest) — 2018-01-04

## README

# ClickShare Utilities
An unofficial ClickShare utility package for NodeJS

## Installation

Using npm:
```shell
$ npm i --save clickshare-utils
```

In Node.js:
```js
const clickshare = require('clickshare-utils');
// Load the constructor to create multiple base units.

const Baseunit = clickshare.Baseunit;
let baseunitOne = new Baseunit('127.0.0.1');

// Search for different Base Units - discovery is a singleton.
const discovery = clickshare.discovery;
discovery.on('up', function(ip) {
  console.log('found a ClickShare on ip: '+ip);
});
discovery.start();

// Set up a proxy to a Base Unit API at port 1000.
const Proxy = clickshare.Proxy;
let proxyOne = new Proxy('127.0.0.1',1000);
proxyOne.start();
```

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