Interface Waku

interface Waku {
    connectionManager: IConnectionManager;
    filter?: IFilter;
    libp2p: Libp2p;
    lightPush?: ILightPushSDK;
    relay?: IRelay;
    store?: IStoreSDK;
    dial(peer, protocols?): Promise<Stream>;
    isConnected(): boolean;
    isStarted(): boolean;
    start(): Promise<void>;
    stop(): Promise<void>;
}

Hierarchy (view full)

Waku

Index

Properties

connectionManager filter? libp2p lightPush? relay? store?

Methods

dial isConnected isStarted start stop

Properties

connectionManager

connectionManager: IConnectionManager

`Optional` filter

filter?: IFilter

libp2p

libp2p: Libp2p

`Optional` lightPush

lightPush?: ILightPushSDK

`Optional` relay

relay?: IRelay

`Optional` store

store?: IStoreSDK

Methods

dial

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

isConnected

isConnected(): boolean
Returns boolean
- Defined in packages/interfaces/src/waku.ts:29

isStarted

isStarted(): boolean
Returns boolean
- Defined in packages/interfaces/src/waku.ts:27

start

start(): Promise<void>
Returns Promise<void>
- Defined in packages/interfaces/src/waku.ts:23

stop

stop(): Promise<void>
Returns Promise<void>
- Defined in packages/interfaces/src/waku.ts:25

Generated using TypeDoc