waku-org
/
js-waku
mirror of https://github.com/waku-org/js-waku.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix more comments

This commit is contained in:
Nicholas Molnar 2022-05-16 11:00:35 -07:00 committed by Franck Royer
parent c534bd6cff
commit cd71beb26b
No known key found for this signature in database
GPG Key ID: A82ED75A8DFC50A4
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/lib/waku_filter/index.ts
View File

@ -22,11 +22,11 @@ type FilterSubscriptionOpts = {
*/ */
topic?: string; topic?: string;
/** /**
* Optionally specify a PeerId for the subscription. If not included, will use a random peer * Optionally specify a PeerId for the subscription. If not included, will use a random peer.
*/ */
peerId?: PeerId; peerId?: PeerId;
/** /**
* Array of ContentTopics to subscribe to. If empty, will subscribe to all messages on the network * Array of ContentTopics to subscribe to. If empty, no messages will be returned from the filter.
*/ */
contentTopics: string[]; contentTopics: string[];
}; };
@ -38,7 +38,7 @@ type UnsubscribeFunction = () => Promise<void>;
/** /**
* Implements part of the [Waku v2 Filter protocol](https://rfc.vac.dev/spec/12/). * Implements part of the [Waku v2 Filter protocol](https://rfc.vac.dev/spec/12/).
* *
* WakuFilter can be used as a light filter node, but cannot currently be used as a full node that pushes messages to clients * WakuFilter can be used as a light filter node, but cannot currently be used as a full node that pushes messages to clients.
*/ */
export class WakuFilter { export class WakuFilter {
private subscriptions: { private subscriptions: {