doc: Remove warnings

This commit is contained in:
F 2021-12-02 23:42:35 +11:00
parent 05367e3704
commit eb9057fc8f
No known key found for this signature in database
GPG Key ID: A82ED75A8DFC50A4
4 changed files with 14 additions and 4 deletions

View File

@ -11,6 +11,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Test: Upgrade nim-waku node to v0.6. - Test: Upgrade nim-waku node to v0.6.
### Fixed
- Doc: Some broken links.
## [0.14.2] - 2021-11-30 ## [0.14.2] - 2021-11-30
### Changed ### Changed

View File

@ -2,8 +2,10 @@ export { getBootstrapNodes } from './lib/discovery';
export * as utils from './lib/utils'; export * as utils from './lib/utils';
export * as waku from './lib/waku';
export { Waku, DefaultPubSubTopic } from './lib/waku'; export { Waku, DefaultPubSubTopic } from './lib/waku';
export * as waku_message from './lib/waku_message';
export { WakuMessage } from './lib/waku_message'; export { WakuMessage } from './lib/waku_message';
export { export {
@ -12,14 +14,17 @@ export {
getPublicKey, getPublicKey,
} from './lib/waku_message/version_1'; } from './lib/waku_message/version_1';
export * as waku_light_push from './lib/waku_light_push';
export { export {
WakuLightPush, WakuLightPush,
LightPushCodec, LightPushCodec,
PushResponse, PushResponse,
} from './lib/waku_light_push'; } from './lib/waku_light_push';
export * as waku_relay from './lib/waku_relay';
export { WakuRelay, RelayCodecs } from './lib/waku_relay'; export { WakuRelay, RelayCodecs } from './lib/waku_relay';
export * as waku_store from './lib/waku_store';
export { PageDirection, WakuStore, StoreCodec } from './lib/waku_store'; export { PageDirection, WakuStore, StoreCodec } from './lib/waku_store';
export * as proto from './proto'; export * as proto from './proto';

View File

@ -6,7 +6,7 @@ import Libp2p from 'libp2p';
import { Peer } from 'libp2p/src/peer-store'; import { Peer } from 'libp2p/src/peer-store';
import PeerId from 'peer-id'; import PeerId from 'peer-id';
import { HistoryResponse_Error } from '../../proto/waku/v2/store'; import { HistoryResponse_Error } from '../../proto';
import { getPeersForProtocol, selectRandomPeer } from '../select_peer'; import { getPeersForProtocol, selectRandomPeer } from '../select_peer';
import { hexToBuf } from '../utils'; import { hexToBuf } from '../utils';
import { DefaultPubSubTopic } from '../waku'; import { DefaultPubSubTopic } from '../waku';
@ -51,13 +51,13 @@ export interface QueryOptions {
pubSubTopic?: string; pubSubTopic?: string;
/** /**
* The direction in which pages are retrieved: * The direction in which pages are retrieved:
* - [[Direction.BACKWARD]]: Most recent page first. * - [[PageDirection.BACKWARD]]: Most recent page first.
* - [[Direction.FORWARD]]: Oldest page first. * - [[PageDirection.FORWARD]]: Oldest page first.
* *
* Note: This does not affect the ordering of messages with the page * Note: This does not affect the ordering of messages with the page
* (oldest message is always first). * (oldest message is always first).
* *
* @default [[Direction.BACKWARD]] * @default [[PageDirection.BACKWARD]]
*/ */
pageDirection?: PageDirection; pageDirection?: PageDirection;
/** /**

View File

@ -7,5 +7,6 @@ export {
ContentFilter, ContentFilter,
HistoryQuery, HistoryQuery,
HistoryResponse, HistoryResponse,
HistoryResponse_Error,
HistoryRPC, HistoryRPC,
} from './waku/v2/store'; } from './waku/v2/store';