https://github.com/hyperswarm/replicator

Replicate data structures easily using hyperswarm
https://github.com/hyperswarm/replicator

Last synced: 3 months ago
JSON representation

Replicate data structures easily using hyperswarm

• Host: GitHub
• URL: https://github.com/hyperswarm/replicator
• Owner: hyperswarm
• Created: 2019-08-07T09:35:01.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-04-04T15:29:47.000Z (over 2 years ago)
• Last Synced: 2024-07-19T09:27:06.391Z (4 months ago)
• Language: JavaScript
• Size: 19.5 KB
• Stars: 44
• Watchers: 4
• Forks: 14
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# @hyperswarm/replicator

Replicate data structures easily using hyperswarm

## Install

```js

npm install @hyperswarm/replicator

```

## Usage

You data structure has to support a .replicate() stream, then you can replicate

them using the hyperswarm replicator.

```js

const Replicator = require('@hyperswarm/replicator')

const r = new Replicator()

r.add(aHypercore, {

  live: true // passed to .replicate

})

```

## API

#### `r = new Replicator([options])`

Make a new replicator. Options include:

```js

{

  bootstrap: [...], // optional set the DHT bootstrap servers

}

```

#### `promise = r.add(hyperDataStructure, [options])`

Add a hyper* data structure to replicate.

```js

{

  live: bool, // passed to .replicate

  upload: bool, // passed to .replicate

  download: bool, // passed to .replicate

  encrypt: bool, // passed to .replicate

  discoveryKey: , // optionally set your own discovery key

  announce: true, // should the swarm announce you?

  lookup: true, // should the swarm do lookups for you?

  keyPair: { publicKey, secretKey }, // noise keypair used for the connection

  onauthenticate (remotePublicKey, done) // the onauthenticate hook to verify remote key pairs

}

```

Promise resolves when the data structure has been fully added.

#### `promise = r.remove(hyperDataStructure)`

Remove a data structure from replication.

Promise resolves when the data structure has been fully removed.

#### `r.swarm`

The associated hyperswarm instance.

#### `r.on('discovery-key', (discoveryKey, remoteStream) => ...)`

Emitted when a remote asks for a discovery key of a data structure you are

not currently replicating.

#### `r = Replicator.replicate(hyperDataStructure[s])`

Easy "one off" replication of one or more data structures.

## License

MIT