chore: fix doc generation

This commit is contained in:
fryorcraken.eth 2023-02-09 14:45:32 +11:00
parent c2cef9a319
commit c3b01751ce
No known key found for this signature in database
GPG Key ID: A82ED75A8DFC50A4
3 changed files with 6 additions and 5 deletions

View File

@ -28,7 +28,7 @@
"proto": "npm run proto --workspaces --if-present",
"deploy": "node ci/deploy.js",
"doc": "run-s doc:*",
"doc:html": "typedoc --options typedoc.cjs --treatWarningsAsErrors",
"doc:html": "typedoc --options typedoc.cjs",
"doc:cname": "echo 'js.waku.org' > docs/CNAME"
},
"devDependencies": {

View File

@ -30,19 +30,19 @@ export interface WakuOptions {
* Set keep alive frequency in seconds: Waku will send a `/ipfs/ping/1.0.0`
* request to each peer after the set number of seconds. Set to 0 to disable.
*
* @default {@link DefaultPingKeepAliveValueSecs}
* @default {@link @waku/core.DefaultPingKeepAliveValueSecs}
*/
pingKeepAlive?: number;
/**
* Set keep alive frequency in seconds: Waku will send a ping message over
* relay to each peer after the set number of seconds. Set to 0 to disable.
*
* @default {@link DefaultRelayKeepAliveValueSecs}
* @default {@link @waku/core.DefaultRelayKeepAliveValueSecs}
*/
relayKeepAlive?: number;
/**
* Set the user agent string to be used in identification of the node.
* @default {@link DefaultUserAgent}
* @default {@link @waku/core.DefaultUserAgent}
*/
userAgent?: string;
}

View File

@ -8,9 +8,10 @@ module.exports = {
out: "docs",
exclude: ["**/*.spec.ts"],
excludeInternal: true,
treatWarningsAsErrors: true,
excludeExternals: true,
validation: {
invalidLink: true,
notExported: true,
},
};
packageJson.workspaces;