Commit 83aa4390eafb9a0d668287e70f75f4b64bcb27d5
add note about stream
mix irving committed on 1/31/2018, 3:20:17 AMParent: 92f5724222307187f23d545ec3c17c9aeedd6922
Files changed
README.md | changed |
README.md | ||
---|---|---|
@@ -62,7 +62,15 @@ | ||
62 | 62 … | [ChannelName]: Set // set of FeedIds of users subscribed to that channel |
63 | 63 … | } |
64 | 64 … | ``` |
65 | 65 … | |
66 | -### server.channel.get(cb) | |
66 … | +### server.channel.stream() => pull-stream source | |
67 | 67 … | |
68 … | +Be careful, this is a stream which provides: | |
69 … | +- an initial value | |
70 … | +- 'change' values (for all values after the initial value) | |
71 … | +- `{ sync: true }` values when the view is up to date with the db (if you use the `{live: true}` option) | |
68 | 72 … | |
73 … | +For details see : [https://github.com/flumedb/flumeview-reduce](https://github.com/flumedb/flumeview-reduce#dbnamestreamlive-boolean--pullsource) | |
74 … | + | |
75 … | + | |
76 … | + |
Built with git-ssb-web