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: outdated doc & links

This commit is contained in:
fryorcraken.eth 2022-08-05 23:47:38 +10:00
parent 889ec4d45c
commit 8c27975830
No known key found for this signature in database
GPG Key ID: A82ED75A8DFC50A4
2 changed files with 3 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/lib/create_waku.ts
View File

@ -44,12 +44,7 @@ export interface CreateOptions {
*/
staticNoiseKey?: Uint8Array;
/**
* Use libp2p-bootstrap to discover and connect to new nodes.
*
* See [[BootstrapOptions]] for available parameters.
*
* Note: It overrides any other peerDiscovery modules that may have been set via
* {@link CreateOptions.libp2p}.
* Use recommended bootstrap method to discovery and connect to new nodes.
*/
defaultBootstrap?: boolean;
}

3
src/lib/wait_for_remote_peer.ts
View File

@ -22,7 +22,8 @@ interface WakuGossipSubProtocol extends GossipSub {
/**
* Wait for a remote peer to be ready given the passed protocols.
* Useful when using the [[CreateOptions.bootstrap]] with [[createWaku]].
* Must be used after attempting to connect to nodes, using {@link Waku.dial} or
* a bootstrap method with {@link Waku.constructor}.
*
* If the passed protocols is a GossipSub protocol, then it resolves only once
* a peer is in a mesh, to help ensure that other peers will send and receive