# node-ironio

> iron.io client

Latest version **0.4.2** (published 2017-01-20) · 0 weekly downloads

## Install

```sh
npm install node-ironio
pnpm add node-ironio
yarn add node-ironio
bun add node-ironio
```

## 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.4.2 |
| Published | 2017-01-20 |
| First published | 2012-12-29 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 31 |
| Author | Andrew Hallock |
| Maintainers | ahallock |
| Keywords | ironio, ironmq, ironcache, ironworker |

## Links

- npm: https://www.npmjs.com/package/node-ironio
- Repository: https://github.com/ahallock/node-ironio
- Homepage: https://github.com/ahallock/node-ironio#readme
- Issues: http://github.com/ahallock/node-ironio/issues
- npm.io page: https://npm.io/package/node-ironio

## Dependencies (1)

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

## Alternatives

- [memory-cache](https://npm.io/package/memory-cache.md) — 795.0K weekly downloads
- [@httptoolkit/proxy-agent](https://npm.io/package/@httptoolkit/proxy-agent.md) — 11.2K weekly downloads
- [express-cache-controller](https://npm.io/package/express-cache-controller.md) — 5.3K weekly downloads
- [http-cache-middleware](https://npm.io/package/http-cache-middleware.md) — 4.5K weekly downloads
- [cache2](https://npm.io/package/cache2.md) — 1.5K weekly downloads

## Recent versions

- 0.4.2 (latest) — 2017-01-20
- 0.4.0 — 2013-11-22
- 0.3.1 — 2013-01-28
- 0.2.0 — 2013-01-27
- 0.1.0 — 2012-12-29

## README

# node-ironio 

node-ironio is a Node.js client for IronMQ, IronWorker, and IronCache. See http://www.iron.io
for more details. node-ironio is inspired by seebees' ironmq module: https://github.com/seebees/ironmq 

## Install
    npm install node-ironio

## Examples
```javascript
var ironio = require('node-ironio')('OAuth token')
  , project = ironio.projects('Project ID');

// IronMQ
var q = project.queues('myqueue');

// Get a message
q.get(function(err, message) {
  // do something with the message
  // then delete it
  message.del(function(err) {

  });
  // need more time?
  // touch the message
  message.touch(function(err) {

  });

  // can't process the message
  // release the message
  message.release(function(err) {

  });
});

// Enqueue a message
q.post('message', function(err, res) {

});

// IronCache
var c = project.caches('mycache');

// Add an item to the cache
c.put('key', 'value', function(err) {

});

// Get an item from the cache
c.get('key', function(err, val) {
  // do something with the val
});

// IronWorker

// Enqueue a task
project.tasks.queue({
                      code_name: 'code name',
                      payload: 'payload',
                      priority: 0,
                      delay: 0,
                      label: 'label name',
                      cluster: 'default'
                    },
                    function(err, res) {

});
```
See the test directory for more examples. 

## Future Work
* IronWorker code package endpoints
* CI for uploading IronWorker modules
* Better configuration handling 
* More documentation and examples

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