# docker-events

> Create an event emitter from dockerode's events response

Latest version **0.0.2** (published 2014-08-27) · BSD license · 0 weekly downloads

## Install

```sh
npm install docker-events
pnpm add docker-events
yarn add docker-events
bun add docker-events
```

## Health

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

Positive: has types package; no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2014-08-27 |
| First published | 2014-04-08 |
| Weekly downloads | 0 |
| License | BSD |
| TypeScript types | separate (@types/docker-events) |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 32 |
| Author | Conrad Pankoff |
| Maintainers | deoxxa |
| Keywords | docker, events, event, emitter |

## Links

- npm: https://www.npmjs.com/package/docker-events
- Repository: https://github.com/deoxxa/docker-events
- Issues: https://github.com/deoxxa/docker-events/issues
- npm.io page: https://npm.io/package/docker-events

## Dependencies (1)

- [jsuck](https://npm.io/package/jsuck.md) 0.0.4

## Alternatives

- [async-exit-hook](https://npm.io/package/async-exit-hook.md) — 3.7M weekly downloads
- [evnty](https://npm.io/package/evnty.md) — 7.2K weekly downloads
- [eleventy-plugin-asciidoc](https://npm.io/package/eleventy-plugin-asciidoc.md) — 3.5K weekly downloads
- [@jswork/next-get2get](https://npm.io/package/@jswork/next-get2get.md) — 945 weekly downloads
- [@dashersw/axon](https://npm.io/package/@dashersw/axon.md) — 934 weekly downloads

## Recent versions

- 0.0.2 (latest) — 2014-08-27
- 0.0.1 — 2014-04-08

## README

docker-events
=============

Create an event emitter from dockerode's events response

Overview
--------

Docker exposes an event API, allowing one to monitor the happenings of a Docker
host. dockerode allows for consumption of this API, albeit in a very raw form.
docker-events does a bit of work for you, turning the raw API of dockerode into
something a little more high-level by parsing the response stream and pushing
things out of an EventEmitter.

API
---

### DockerEvents (constructor)

```js
var emitter = new DockerEvents({
  docker: new Dockerode(options),
});
```

### start

```js
emitter.start();
```

### stop

```js
emitter.stop();
```

### #connect

```js
emitter.on("connect", function() {
  console.log("connected to docker api");
});
```

### #disconnect

```js
emitter.on("disconnect", function() {
  console.log("disconnected to docker api; reconnecting");
});
```

### #_message

```js
emitter.on("_message", function(message) {
  console.log("got a message from docker: %j", message);
});
```

### #create

```js
emitter.on("create", function(message) {
  console.log("container created: %j", message);
});
```

### #start

```js
emitter.on("start", function(message) {
  console.log("container started: %j", message);
});
```

### #stop

```js
emitter.on("stop", function(message) {
  console.log("container stopped: %j", message);
});
```

### #die

```js
emitter.on("die", function(message) {
  console.log("container died: %j", message);
});
```

### #destroy

```js
emitter.on("destroy", function(message) {
  console.log("container destroyed: %j", message);
});
```

License
-------

3-clause BSD. A copy is included with the source.

Contact
-------

* GitHub ([deoxxa](http://github.com/deoxxa))
* Twitter ([@deoxxa](http://twitter.com/deoxxa))
* Email ([deoxxa@fknsrs.biz](mailto:deoxxa@fknsrs.biz))

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