night0721/cath
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

updated missing typings

Browse source
This commit is contained in:
night0721 2021-09-19 21:41:55 +08:00
parent 85f2adfcff
commit 248c7a38dd
7 changed files with 10 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/assets/search.js
View file

File diff suppressed because one or more lines are too long

2
docs/index.html
View file

@ -56,4 +56,4 @@ To Request new features contact us on Discord using the support server.</p>
<p align = "center">
<a href="https://rebrand.ly/cathSupport" target="_blank"><img src="https://discordapp.com/api/guilds/718762019586572341/widget.png?style=banner1"></a>
</p>
</div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class"><a href="classes/CODMClient.html" class="tsd-kind-icon">CODMClient</a></li><li class="tsd-kind-class"><a href="classes/StarboardClient.html" class="tsd-kind-icon">Starboard<wbr/>Client</a></li><li class="tsd-kind-interface"><a href="interfaces/CODMClientOptions.html" class="tsd-kind-icon">CODMClient<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardClientOptions.html" class="tsd-kind-icon">Starboard<wbr/>Client<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuild.html" class="tsd-kind-icon">Starboard<wbr/>Guild</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuildOptions.html" class="tsd-kind-icon">Starboard<wbr/>Guild<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/starMessageData.html" class="tsd-kind-icon">star<wbr/>Message<wbr/>Data</a></li><li class="tsd-kind-function"><a href="modules.html#random8ball" class="tsd-kind-icon">random8ball</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>
</div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class"><a href="classes/CODMClient.html" class="tsd-kind-icon">CODMClient</a></li><li class="tsd-kind-class"><a href="classes/StarboardClient.html" class="tsd-kind-icon">Starboard<wbr/>Client</a></li><li class="tsd-kind-interface"><a href="interfaces/CODMClientOptions.html" class="tsd-kind-icon">CODMClient<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardClientOptions.html" class="tsd-kind-icon">Starboard<wbr/>Client<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuild.html" class="tsd-kind-icon">Starboard<wbr/>Guild</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuildOptions.html" class="tsd-kind-icon">Starboard<wbr/>Guild<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/starMessageData.html" class="tsd-kind-icon">star<wbr/>Message<wbr/>Data</a></li><li class="tsd-kind-function"><a href="modules.html#getreddit" class="tsd-kind-icon">getreddit</a></li><li class="tsd-kind-function"><a href="modules.html#random8ball" class="tsd-kind-icon">random8ball</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>

6
docs/modules.html
View file

@ -1,3 +1,5 @@
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>cath</title><meta name="description" content="Documentation for cath"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">cath</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1>cath</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class"><a href="classes/CODMClient.html" class="tsd-kind-icon">CODMClient</a></li><li class="tsd-kind-class"><a href="classes/StarboardClient.html" class="tsd-kind-icon">Starboard<wbr/>Client</a></li></ul></section><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface"><a href="interfaces/CODMClientOptions.html" class="tsd-kind-icon">CODMClient<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardClientOptions.html" class="tsd-kind-icon">Starboard<wbr/>Client<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuild.html" class="tsd-kind-icon">Starboard<wbr/>Guild</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuildOptions.html" class="tsd-kind-icon">Starboard<wbr/>Guild<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/starMessageData.html" class="tsd-kind-icon">star<wbr/>Message<wbr/>Data</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function"><a href="modules.html#random8ball" class="tsd-kind-icon">random8ball</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function"><a name="random8ball" class="tsd-anchor"></a><h3>random8ball</h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">random8ball<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in functions/8ball.ts:7</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>cath</title><meta name="description" content="Documentation for cath"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">cath</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1>cath</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class"><a href="classes/CODMClient.html" class="tsd-kind-icon">CODMClient</a></li><li class="tsd-kind-class"><a href="classes/StarboardClient.html" class="tsd-kind-icon">Starboard<wbr/>Client</a></li></ul></section><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface"><a href="interfaces/CODMClientOptions.html" class="tsd-kind-icon">CODMClient<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardClientOptions.html" class="tsd-kind-icon">Starboard<wbr/>Client<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuild.html" class="tsd-kind-icon">Starboard<wbr/>Guild</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuildOptions.html" class="tsd-kind-icon">Starboard<wbr/>Guild<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/starMessageData.html" class="tsd-kind-icon">star<wbr/>Message<wbr/>Data</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function"><a href="modules.html#getreddit" class="tsd-kind-icon">getreddit</a></li><li class="tsd-kind-function"><a href="modules.html#random8ball" class="tsd-kind-icon">random8ball</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function"><a name="getreddit" class="tsd-anchor"></a><h3>getreddit</h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">getreddit<span class="tsd-signature-symbol">(</span>sub<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in functions/reddit.ts:6</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Sends an embed of reddit</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>sub: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span></h4><div></div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a name="random8ball" class="tsd-anchor"></a><h3>random8ball</h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">random8ball<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in functions/8ball.ts:7</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Sends a 8ball response</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><div></div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class"><a href="classes/CODMClient.html" class="tsd-kind-icon">CODMClient</a></li><li class="tsd-kind-class"><a href="classes/StarboardClient.html" class="tsd-kind-icon">Starboard<wbr/>Client</a></li><li class="tsd-kind-interface"><a href="interfaces/CODMClientOptions.html" class="tsd-kind-icon">CODMClient<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardClientOptions.html" class="tsd-kind-icon">Starboard<wbr/>Client<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuild.html" class="tsd-kind-icon">Starboard<wbr/>Guild</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuildOptions.html" class="tsd-kind-icon">Starboard<wbr/>Guild<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/starMessageData.html" class="tsd-kind-icon">star<wbr/>Message<wbr/>Data</a></li><li class="tsd-kind-function"><a href="modules.html#random8ball" class="tsd-kind-icon">random8ball</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><div></div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class"><a href="classes/CODMClient.html" class="tsd-kind-icon">CODMClient</a></li><li class="tsd-kind-class"><a href="classes/StarboardClient.html" class="tsd-kind-icon">Starboard<wbr/>Client</a></li><li class="tsd-kind-interface"><a href="interfaces/CODMClientOptions.html" class="tsd-kind-icon">CODMClient<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardClientOptions.html" class="tsd-kind-icon">Starboard<wbr/>Client<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuild.html" class="tsd-kind-icon">Starboard<wbr/>Guild</a></li><li class="tsd-kind-interface"><a href="interfaces/StarboardGuildOptions.html" class="tsd-kind-icon">Starboard<wbr/>Guild<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/starMessageData.html" class="tsd-kind-icon">star<wbr/>Message<wbr/>Data</a></li><li class="tsd-kind-function"><a href="modules.html#getreddit" class="tsd-kind-icon">getreddit</a></li><li class="tsd-kind-function"><a href="modules.html#random8ball" class="tsd-kind-icon">random8ball</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>

3
package.json
View file

@ -1,6 +1,6 @@
{
"name": "cath",
"version": "1.2.7",
"version": "1.2.8",
"description": "A powerful package that can interact with Cath API",
"main": "./dist/index.js",
"types": "./dist/index.d.ts",
@ -9,6 +9,7 @@
"dev": "nodemon .",
"build": "tsc",
"start": "node .",
"docs": "npx typedoc src/index.ts",
"node-update": "npm i --save-dev node@16 && npm config set prefix=$(pwd)/node_modules/node && export PATH=$(pwd)/node_modules/node/bin:$PATH",
"node-clean": "rm -rf node_modules && rm package-lock.json && npm cache clear --force && npm cache clean --force && npm i",
"node-update-then-clean": "npm run node-update && npm run node-clean-cache",

1
src/index.d.ts vendored
View file

@ -7,3 +7,4 @@ export {
starMessageData,
} from "./StarboardClient/index";
export { random8ball } from "./functions/8ball";
export { getreddit } from "./functions/reddit";

1
src/index.ts
View file

@ -7,3 +7,4 @@ export {
starMessageData,
} from "./StarboardClient/index";
export { random8ball } from "./functions/8ball";
export { getreddit } from "./functions/reddit";

11
src/typings/index.d.ts vendored
View file

@ -1,11 +0,0 @@
import { CODMClientOptions } from "../CODMClient";
declare module "cath" {
export class CODMClient {
public constructor(key: CODMClientOptions);
private key: string;
public getperk(perk: string): Promise<object>;
}
export function random8ball(): Promise<string>;
}