Replicates data structures easily using hyperswarm
npm install @hyperswarm/replicatorReplicate data structures easily using hyperswarm
``js`
npm install @hyperswarm/replicator
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
})
`
#### 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:
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.
MIT