logos-messaging/js-waku
1
0
Fork 0
mirror of https://github.com/logos-messaging/js-waku.git synced 2026-01-06 15:53:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix links

Browse Source
This commit is contained in:
fryorcraken.eth 2022-09-08 18:44:16 +10:00
parent 6ef0a69d07
commit c9963a4aea
No known key found for this signature in database
GPG Key ID: A82ED75A8DFC50A4
3 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/lib/create_waku.ts
View File

@ -53,8 +53,9 @@ export interface CreateOptions {
/** /**
* Create a Waku node that uses Waku Light Push, Filter and Store to send and * Create a Waku node that uses Waku Light Push, Filter and Store to send and
* receive messages, enabling low resource consumption. * receive messages, enabling low resource consumption.
* **Note: This is NOT compatible with nwaku** * **Note: This is NOT compatible with nwaku v0.11**
* Ref: https://github.com/status-im/nwaku/issues/1085 *
* @see https://github.com/status-im/nwaku/issues/1085
*/ */
export async function createLightNode( export async function createLightNode(
options?: CreateOptions & WakuOptions options?: CreateOptions & WakuOptions
@ -139,8 +140,8 @@ export async function createFullNode(
} }
/** /**
* @deprecated use { @link createLightNode } (only compatible with nwaku v0.12), * @deprecated use { @link createLightNode }, { @link createPrivacyNode } or
* { @link createPrivacyNode } or { @link Waku.constructor } instead; * { @link index.waku.WakuNode.constructor } instead.
*/ */
export async function createWaku( export async function createWaku(
options?: CreateOptions & WakuOptions options?: CreateOptions & WakuOptions

5
src/lib/wait_for_remote_peer.ts
View File

@ -23,8 +23,9 @@ interface WakuGossipSubProtocol extends GossipSub {
/** /**
* Wait for a remote peer to be ready given the passed protocols. * Wait for a remote peer to be ready given the passed protocols.
* Must be used after attempting to connect to nodes, using {@link index.waku.Waku.dial} or * Must be used after attempting to connect to nodes, using
* a bootstrap method with {@link index.waku.Waku.constructor}. * {@link index.waku.WakuNode.dial} or a bootstrap method with
* {@link lib/create_waku.createLightNode}.
* *
* If the passed protocols is a GossipSub protocol, then it resolves only once * 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 * a peer is in a mesh, to help ensure that other peers will send and receive

1
typedoc.json
View File

@ -2,6 +2,7 @@
"entryPoints": [ "entryPoints": [
"./src/index.ts", "./src/index.ts",
"./src/lib/create_waku.ts", "./src/lib/create_waku.ts",
"./src/lib/interfaces.ts",
"./src/lib/peer_discovery_dns.ts", "./src/lib/peer_discovery_dns.ts",
"./src/lib/peer_discovery_static_list.ts", "./src/lib/peer_discovery_static_list.ts",
"./src/lib/predefined_bootstrap_nodes.ts", "./src/lib/predefined_bootstrap_nodes.ts",