# scuttlelog

> Scuttlebutt as a log

Latest version **1.1.0** (published 2014-08-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install scuttlelog
pnpm add scuttlelog
yarn add scuttlelog
bun add scuttlelog
```

## 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.1.0 |
| Published | 2014-08-09 |
| First published | 2014-08-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Mathias Buus |
| Maintainers | mafintosh |
| Keywords | scuttlebutt, p2p, log, change, feed, changes |

## Links

- npm: https://www.npmjs.com/package/scuttlelog
- Repository: https://github.com/mafintosh/scuttlelog
- Issues: https://github.com/mafintosh/scuttlelog/issues
- npm.io page: https://npm.io/package/scuttlelog

## Dependencies (4)

- [cuid](https://npm.io/package/cuid.md) ^1.2.4
- [once](https://npm.io/package/once.md) ^1.3.0
- [duplexify](https://npm.io/package/duplexify.md) ^3.1.0
- [ldjson-stream](https://npm.io/package/ldjson-stream.md) ^1.1.0

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 1.1.0 (latest) — 2014-08-09
- 1.0.0 — 2014-08-09

## README

# scuttlelog

The replication log from [scuttlebutt](https://github.com/dominictarr/scuttlebutt) but as a seperate module

```
npm install scuttlelog
```

[![build status](http://img.shields.io/travis/mafintosh/scuttlelog.svg?style=flat)](http://travis-ci.org/mafintosh/scuttlelog)

## Usage

Use this to implement your own scuttlebutt like data structure with a custom changes feed

``` js
var scuttlelog = require('scuttlelog')

var log = scuttlelog()

log.change({ // add something to the changes feed
  hello: 'world'
})

var log2 = scuttlelog()

log2.on('change', function(change) {
  console.log('change received', change)
})

// replicate between the logs
var s = log.createStream()
s.pipe(log2.createStream()).pipe(s)
```

## License

MIT

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