fix: ensure types are available in doc

This commit is contained in:
Franck Royer 2022-07-27 16:02:57 +10:00 committed by fryorcraken.eth
parent 8126e96f33
commit 95deb6a331
No known key found for this signature in database
GPG Key ID: A82ED75A8DFC50A4
3 changed files with 10 additions and 4 deletions

View File

@ -15,12 +15,17 @@ export * as utils from "./lib/utils";
export { waitForRemotePeer } from "./lib/wait_for_remote_peer"; export { waitForRemotePeer } from "./lib/wait_for_remote_peer";
export * as proto_message from "./proto/message";
export * as waku from "./lib/waku"; export * as waku from "./lib/waku";
export { createWaku, Waku, Protocols } from "./lib/waku"; export { createWaku, Waku, Protocols } from "./lib/waku";
export * as waku_message from "./lib/waku_message"; export * as waku_message from "./lib/waku_message";
export { WakuMessage } from "./lib/waku_message"; export { WakuMessage } from "./lib/waku_message";
export * as waku_filter from "./lib/waku_filter";
export { WakuFilter } from "./lib/waku_filter";
export * as waku_light_push from "./lib/waku_light_push"; export * as waku_light_push from "./lib/waku_light_push";
export { export {
WakuLightPush, WakuLightPush,

View File

@ -22,7 +22,7 @@ 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.
* Useful when using the [[CreateOptions.bootstrap]] with [[Waku.create]]. * Useful when using the [[CreateOptions.bootstrap]] with [[createWaku]].
* *
* 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

View File

@ -15,6 +15,7 @@ import { hexToBytes } from "../utils";
import { DecryptionMethod, WakuMessage } from "../waku_message"; import { DecryptionMethod, WakuMessage } from "../waku_message";
import { ContentFilter, FilterRPC } from "./filter_rpc"; import { ContentFilter, FilterRPC } from "./filter_rpc";
export { ContentFilter };
export const FilterCodec = "/vac/waku/filter/2.0.0-beta1"; export const FilterCodec = "/vac/waku/filter/2.0.0-beta1";
@ -32,7 +33,7 @@ export interface CreateOptions {
pubSubTopic?: string; pubSubTopic?: string;
} }
type FilterSubscriptionOpts = { export type FilterSubscriptionOpts = {
/** /**
* The Pubsub topic for the subscription * The Pubsub topic for the subscription
*/ */
@ -43,9 +44,9 @@ type FilterSubscriptionOpts = {
peerId?: PeerId; peerId?: PeerId;
}; };
type FilterCallback = (msg: WakuMessage) => void | Promise<void>; export type FilterCallback = (msg: WakuMessage) => void | Promise<void>;
type UnsubscribeFunction = () => Promise<void>; export type UnsubscribeFunction = () => Promise<void>;
/** /**
* Implements client side of the [Waku v2 Filter protocol](https://rfc.vac.dev/spec/12/). * Implements client side of the [Waku v2 Filter protocol](https://rfc.vac.dev/spec/12/).