dexiecable 2.0.0.alpha5 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16d440593b555940ff8039e04091edf54026d8678183acfb5d56b6189b08560c
-  data.tar.gz: 78c9c8e4b7e8e9cd3ae3d8cb7367b040962ef7ea0149d167a20396c58093a938
+  metadata.gz: 36154d26195467f83401235810a4bc86b3fec7402c7601aae8bf1bd1c4097406
+  data.tar.gz: eb647d275d24a875a65af6c2d428c057579dda3653f4567cad31de4b15ed610e
 SHA512:
-  metadata.gz: d1d15766bb5dde84e8aaac57998da45e3dc88665740c6beb333d12dafddb3115b148b4e3b49ec8badf706d898eaba1c6fd7c8ad33e77b2aa60083b6b6e3b3a88
-  data.tar.gz: c716de1ee2d50979513c911b168879da8fc640d49f85ddd288ad70715197691c35ffb9020872a2250ae00a62fb35909214a501f91cdeb458323d31cb201bf511
+  metadata.gz: c50c143233dfaec03433d26779a6fe0ac0ed3e7e3e0ff4c4701651dee6c5fd4f7edef1b5f0fce319bd188cd1ee5d396363a6e8896dc2d6587ca14ed00ca5f247
+  data.tar.gz: 43c90cfbbf0230a4f74bd0c8a2b5cff21870d2fbe2f4dc4ab64809deeafd2460a39f33c708d84b00c9170c80e2eb2ece5d519b36ba9d06dada851a2a1479c88b

data/README.md

@@ -105,13 +105,13 @@ Send that token to the client (render it in a view, return it from an endpoint,
 
 ```js
 const subscription = subscribe(db);
-subscription.addStream(userStream);
+const stopStreaming = subscription.addStream(userStream);
 ```
 
-The client now receives every mutation broadcast to `current_user`. To stop listening:
+`addStream` returns a function that removes the stream, so you can clean up later:
 
 ```js
-subscription.removeStream(userStream);
+stopStreaming(); // equivalent to subscription.removeStream(userStream)
 ```
 
 `addStream`/`removeStream` perform `add_stream`/`remove_stream` on `DexieChannel`, which verifies the token and then `stream_from`/`stop_stream_from` the decoded identifier. `removeAllStreams()` performs `remove_all_streams`, stopping every current stream — handy on logout:
@@ -179,8 +179,8 @@ end
 Then subscribe by name — no token required:
 
 ```js
-subscription.addPublicStream("feed");
-subscription.removePublicStream("feed");
+const stopPublicStream = subscription.addPublicStream("feed");
+stopPublicStream(); // equivalent to subscription.removePublicStream("feed")
 ```
 
 Public streams are namespaced under `public:`, so this path can never reach a signed (private) stream.

data/lib/dexiecable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DexieCable
-  VERSION = "2.0.0.alpha5"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dexiecable
 version: !ruby/object:Gem::Version
-  version: 2.0.0.alpha5
+  version: 2.0.0
 platform: ruby
 authors:
 - Stefan Buhrmester