mirror of https://github.com/waku-org/js-waku.git
docs: fix links
This commit is contained in:
parent
6ef0a69d07
commit
c9963a4aea
|
@ -53,8 +53,9 @@ export interface CreateOptions {
|
|||
/**
|
||||
* Create a Waku node that uses Waku Light Push, Filter and Store to send and
|
||||
* receive messages, enabling low resource consumption.
|
||||
* **Note: This is NOT compatible with nwaku**
|
||||
* Ref: https://github.com/status-im/nwaku/issues/1085
|
||||
* **Note: This is NOT compatible with nwaku v0.11**
|
||||
*
|
||||
* @see https://github.com/status-im/nwaku/issues/1085
|
||||
*/
|
||||
export async function createLightNode(
|
||||
options?: CreateOptions & WakuOptions
|
||||
|
@ -139,8 +140,8 @@ export async function createFullNode(
|
|||
}
|
||||
|
||||
/**
|
||||
* @deprecated use { @link createLightNode } (only compatible with nwaku v0.12),
|
||||
* { @link createPrivacyNode } or { @link Waku.constructor } instead;
|
||||
* @deprecated use { @link createLightNode }, { @link createPrivacyNode } or
|
||||
* { @link index.waku.WakuNode.constructor } instead.
|
||||
*/
|
||||
export async function createWaku(
|
||||
options?: CreateOptions & WakuOptions
|
||||
|
|
|
@ -23,8 +23,9 @@ interface WakuGossipSubProtocol extends GossipSub {
|
|||
|
||||
/**
|
||||
* 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
|
||||
* a bootstrap method with {@link index.waku.Waku.constructor}.
|
||||
* Must be used after attempting to connect to nodes, using
|
||||
* {@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
|
||||
* a peer is in a mesh, to help ensure that other peers will send and receive
|
||||
|
|
|
@ -2,6 +2,7 @@
|
|||
"entryPoints": [
|
||||
"./src/index.ts",
|
||||
"./src/lib/create_waku.ts",
|
||||
"./src/lib/interfaces.ts",
|
||||
"./src/lib/peer_discovery_dns.ts",
|
||||
"./src/lib/peer_discovery_static_list.ts",
|
||||
"./src/lib/predefined_bootstrap_nodes.ts",
|
||||
|
|
Loading…
Reference in New Issue