waku-org
/
js-waku
mirror of https://github.com/waku-org/js-waku.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
package.json
View File

@ -28,7 +28,7 @@
"proto": "npm run proto --workspaces --if-present", "proto": "npm run proto --workspaces --if-present",
"deploy": "node ci/deploy.js", "deploy": "node ci/deploy.js",
"doc": "run-s doc:*", "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" "doc:cname": "echo 'js.waku.org' > docs/CNAME"
}, },
"devDependencies": { "devDependencies": {

6
packages/core/src/lib/waku.ts
View File

@ -30,19 +30,19 @@ export interface WakuOptions {
* Set keep alive frequency in seconds: Waku will send a `/ipfs/ping/1.0.0` * 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. * 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; pingKeepAlive?: number;
/** /**
* Set keep alive frequency in seconds: Waku will send a ping message over * 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. * 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; relayKeepAlive?: number;
/** /**
* Set the user agent string to be used in identification of the node. * Set the user agent string to be used in identification of the node.
* @default {@link DefaultUserAgent} * @default {@link @waku/core.DefaultUserAgent}
*/ */
userAgent?: string; userAgent?: string;
} }

3
typedoc.cjs
View File

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