datastore-pubsub - v7.0.0
datastore-pubsub - v8.0.0
datastore-pubsub
@@ -34,38 +34,34 @@Table of contents
-
-
- -
Install
-$ npm i datastore-pubsub
+$ npm i datastore-pubsub
Browser <script> tag
Loading this module through a script tag will make it's exports available as DatastorePubsub in the global namespace.
-<script src="https://unpkg.com/datastore-pubsub/dist/index.min.js"></script>
+<script src="https://unpkg.com/datastore-pubsub/dist/index.min.js"></script>
Usage
-import { PubSubDatastore } from 'datastore-pubsub'
const dsPubsub = new PubSubDatastore(pubsub, datastore, peerId, validator)
+import { PubSubDatastore } from 'datastore-pubsub'
const dsPubsub = new PubSubDatastore(pubsub, datastore, peerId, validator)
@@ -75,7 +71,7 @@ API
Setup
-new PubSubDatastore(pubsub, datastore, peerId, validator, subscriptionKeyFn)
+new PubSubDatastore(pubsub, datastore, peerId, validator, subscriptionKeyFn)
Creates a DatastorePubsub instance.
Arguments:
@@ -87,13 +83,13 @@ Setup
subscriptionKeyFn (function): function to manipulate the key topic received according to the needs, as well as to block the message received to be published.Note: validator object must be composed by two functions, validate (record: uint8Array, peerId: PeerId) => boolean and select (received: uint8Array, current: uint8Array) => boolean. validate aims to verify if a new record received by pubsub is valid to be stored locally by the node. If it is valid and the node already has a local record stored, select is the function provided to be responsible for deciding which record is the best (newer) between the already stored and the received through pubsub. A validator example can be found at: TODO (js-ipns)
-const dsPubsub = new DatastorePubsub(pubsub, datastore, peerId, validator)
+const dsPubsub = new DatastorePubsub(pubsub, datastore, peerId, validator)
Get
-const buf = await dsPubsub.get(key)
+const buf = await dsPubsub.get(key)
Try to subscribe a topic with Pubsub and receive the current local value if available.
Arguments:
@@ -105,7 +101,7 @@ Get
Put
-await dsPubsub.put(key, val)
+await dsPubsub.put(key, val)
Publishes a value through pubsub.
Arguments:
@@ -118,7 +114,7 @@ Put
Unsubscribe
-await dsPubsub.unsubscribe(key)
+await dsPubsub.unsubscribe(key)
Unsubscribe a previously subscribe value.
Arguments:
@@ -127,13 +123,6 @@ Unsubscribe
Returns Promise<void>
-
- Contribute
-
-Feel free to join in. All welcome. Open an issue!
-This repository falls under the IPFS Code of Conduct.
-
-
API Docs
@@ -150,7 +139,7 @@ License
MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)
-
+
Contribute
Contributions welcome! Please check out the issues.
@@ -178,7 +167,7 @@ Theme
Class PubSubDatastore