Class WakuLightPush

Implements the Waku v2 Light Push protocol.

Hierarchy

WakuLightPush

Index

Constructors

constructor

Properties

Accessors

Methods

push

Constructors

constructor

new WakuLightPush(libp2p: Libp2p, options?: waku_light_push.CreateOptions): WakuLightPush

- Defined in src/lib/waku_light_push/index.ts:41
Parameters
- libp2p: Libp2p
- Optional options: waku_light_push.CreateOptions
Returns WakuLightPush

Properties

libp2p

libp2p: Libp2p

pubSubTopic

pubSubTopic: string

Accessors

peers

get peers(): AsyncIterable<Peer>

- Defined in src/lib/waku_light_push/index.ts:102
Returns known peers from the address book (libp2p.peerStore) that support light push protocol. Waku may or may not be currently connected to these peers.

Returns AsyncIterable<Peer>

randomPeer

get randomPeer(): Promise<undefined | Peer>

- Defined in src/lib/waku_light_push/index.ts:111
Returns a random peer that supports light push protocol from the address book (libp2p.peerStore). Waku may or may not be currently connected to this peer.

Returns Promise<undefined | Peer>

Methods

push

push(message: WakuMessage, opts?: PushOptions): Promise<null | waku_light_push.PushResponse>

- Defined in src/lib/waku_light_push/index.ts:49
Parameters
- message: WakuMessage
- Optional opts: PushOptions
Returns Promise<null | waku_light_push.PushResponse>

Generated using TypeDoc