Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yoshuawuyts/normcore
No-config distributed streams using hypercore
https://github.com/yoshuawuyts/normcore
Last synced: 2 days ago
JSON representation
No-config distributed streams using hypercore
- Host: GitHub
- URL: https://github.com/yoshuawuyts/normcore
- Owner: yoshuawuyts
- License: mit
- Created: 2016-11-05T12:18:49.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2016-12-20T15:35:32.000Z (almost 8 years ago)
- Last Synced: 2024-10-04T14:14:57.302Z (about 1 month ago)
- Language: JavaScript
- Size: 17.6 KB
- Stars: 28
- Watchers: 4
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-peer-to-peer - normcore - config distributed streams using hypercore (Modules)
- awesome-dat - normcore - no-config distributed streams using `hypercore` (Outdated / Other Related Dat Project Modules)
- awesome-peer-to-peer - normcore - config distributed streams using hypercore (Modules)
README
# normcore [![stability][0]][1]
[![npm version][2]][3] [![build status][4]][5]
[![downloads][8]][9] [![js-standard-style][10]][11]
No-config distributed streams using [hypercore][hypercore].
## Usage
```js
const normcore = require('normcore')
const feed1 = normcore('welcome-to-the-norm-zone')
const key = feed1.key.toString('hex')
feed1.append('hello')
feed1.append('this is norman')
const feed2 = normcore(key)
feed2.createReadStream().on('data', function (data) {
console.log('feed2: ' + data.toString())
})
```
## API
### feed = normcore(keyOrNameOrPath, [opts])
Create a new `normcore` instance. If you pass in a hypercore hex key it will
fetch that feed. If you pass it an absolute path it will create a core at that
location. Otherwise it just uses the string as the local db name
`opts`, if specified, gets passed through as `hyperdiscovery` options
### key = feed.key
Get the hypercore key. You probably usually want to turn it into a hex value:
```js
const hypercore = require('hypercore')
const feed = normcore('omnormnormnormnorm')
console.log(feed.key.toString('hex'))
```
### feed.append(data)
Write data into the feed
### writeableStream = feed.createWriteableStream()
Create a new `writeableStream` you can write data to
### readableStream = feed.createReadableStream()
Create a new `readableStream` you can read data from
## Installation
```sh
$ npm install normcore
```
## See Also
- [hypercore][hypercore]
- [hyperdrive-archive-swarm][swarm]
## License
[MIT](https://tldrlegal.com/license/mit-license)
[0]: https://img.shields.io/badge/stability-experimental-orange.svg?style=flat-square
[1]: https://nodejs.org/api/documentation.html#documentation_stability_index
[2]: https://img.shields.io/npm/v/normcore.svg?style=flat-square
[3]: https://npmjs.org/package/normcore
[4]: https://img.shields.io/travis/yoshuawuyts/normcore/master.svg?style=flat-square
[5]: https://travis-ci.org/yoshuawuyts/normcore
[8]: http://img.shields.io/npm/dm/normcore.svg?style=flat-square
[9]: https://npmjs.org/package/normcore
[10]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square
[11]: https://github.com/feross/standard
[hypercore]: https://github.com/mafintosh/hypercore
[swarm]: https://github.com/karissa/hyperdrive-archive-swarm