Interface Waku

Hierarchy

Waku

Implemented by

WakuNode

Index

Properties

filter? libp2p lightPush? relay? store?

Methods

addDecryptionKey addPeerToAddressBook deleteDecryptionKey dial isStarted start stop

Properties

`Optional` filter

filter?: WakuFilter

libp2p

libp2p: Libp2p

`Optional` lightPush

lightPush?: WakuLightPush

`Optional` relay

relay?: WakuRelay

`Optional` store

store?: WakuStore

Methods

addDecryptionKey

addDecryptionKey(key: string | Uint8Array, options?: { contentTopics?: string[]; method?: DecryptionMethod }): void
Parameters
- key: string | Uint8Array
- Optional options: { contentTopics?: string[]; method?: DecryptionMethod }
  - Optional contentTopics?: string[]
  - Optional method?: DecryptionMethod
Returns void
- Defined in src/lib/interfaces.ts:33

addPeerToAddressBook

addPeerToAddressBook(peerId: string | PeerId, multiaddrs: Multiaddr[] | string[]): void
Parameters
- peerId: string | PeerId
- multiaddrs: Multiaddr[] | string[]
Returns void
- Defined in src/lib/interfaces.ts:22

deleteDecryptionKey

deleteDecryptionKey(key: string | Uint8Array): void
Parameters
- key: string | Uint8Array
Returns void
- Defined in src/lib/interfaces.ts:38

dial

dial(peer: PeerId | Multiaddr, protocols?: Protocols[]): Promise<Stream>
Parameters
- peer: PeerId | Multiaddr
- Optional protocols: Protocols[]
Returns Promise<Stream>
- Defined in src/lib/interfaces.ts:20

isStarted

isStarted(): boolean
Returns boolean
- Defined in src/lib/interfaces.ts:31

start

start(): Promise<void>
Returns Promise<void>
- Defined in src/lib/interfaces.ts:27

stop

stop(): Promise<void>
Returns Promise<void>
- Defined in src/lib/interfaces.ts:29

Generated using TypeDoc