# huchat-tools

> Making it easier for your hubot to do cool things with hipchat's api.

Latest version **1.0.1** (published 2016-01-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install huchat-tools
pnpm add huchat-tools
yarn add huchat-tools
bun add huchat-tools
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2016-01-11 |
| First published | 2016-01-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Andrew Schmitt |
| Maintainers | aaaschmitt |
| Keywords | hipchat, hubot, api, hipchat-api, tools, file, upload, share, html, message |

## Links

- npm: https://www.npmjs.com/package/huchat-tools
- Repository: https://github.com/aaaschmitt/huchat-tools
- Homepage: https://github.com/aaaschmitt/huchat-tools#readme
- Issues: https://github.com/aaaschmitt/huchat-tools/issues
- npm.io page: https://npm.io/package/huchat-tools

## Dependencies (4)

- [fs](https://npm.io/package/fs.md) 0.0.2
- [mime](https://npm.io/package/mime.md) ^1.3.4
- [path](https://npm.io/package/path.md) ^0.12.7
- [request](https://npm.io/package/request.md) ^2.67.0

## Alternatives

- [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads
- [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads
- [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads
- [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads
- [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2016-01-11
- 1.0.0 — 2016-01-11

## README

# huchat-tools
Making it easier for your hubot to do cool things with hipchat's api.

# Installation
* In your project repo run:
``` 
	npm install huchat-tools --save
```

* Then wherever you want to use the script just require:
```
var Huchat = require('huchat-tools'),
	huchat = new Huchat('Hipchat_Api_Token');
```

# Features/Examples
See hipchat-api.js for full documentation.
```
var Huchat = require('huchat-tools'),
	huchat = new Huchat('hipchat-api-token');

var cb = function(err, resp) {
	if (err) { return console.log(err.mesg)};

	console.log(resp);
}

// Generate mapping {xmpp-jabber-id : hipchat-api-id}
huchat.createRoomMapping(cb);

// Obtain this from the function above (may be a number or a string)
var roomId = "Some Room's Api Id or Room Name";

// Get metadata for a specific room (including name and api id)
huchat.getRoom(roomId, cb);

// Get a list of rooms accessible for this api token
huchat.listRooms(cb);

// Post some html data (this example posts a hyperlink -- see documentation in hipchat-api.js)
huchat.postHtmlMessage(roomId, '<a href="https://www.hipchat.com">hipchat site</a>', cb);

// Share a file from a given file path and post with a given alias
huchat.shareFile(roomId, 'my_file.csv', 'file alias', cb);
```

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