2021-09-19 15:31:16 +02:00
<!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" > < div class = "tsd-panel tsd-typography" > < h1 align = "center" > CATH < / h1 >
<!-- header -->
< p align = "center" >
< img src = "https://media.discordapp.net/attachments/842014909264953354/867806346593042483/Cath-temp-banner.png?width=1244&height=415" >
< br >
2021-09-20 09:53:40 +02:00
< a href = "https://npmjs.org/package/cath" target = "_blank" > < img alt = 'Version' src = "https://img.shields.io/github/package-json/v/night0721/cath?style=for-the-badge&color=555555&labelColor=02023a" > < / a > < a href = "https://npmjs.org/package/cath" target = "_blank" > < img alt = 'Download' src = "https://img.shields.io/npm/dt/cath?style=for-the-badge&color=02023a" > < / a >
2021-09-19 15:31:16 +02:00
< a href = "https://github.com/night0721/cath.exe/blob/main/LICENSE" target = "_blank" > < img alt = 'Package' src = "https://img.shields.io/static/v1?label=LICENSE&message=Apache%202.0&color=555555&labelColor=02023a&style=for-the-badge&scale=1.4" > < / a >
< a href = "https://github.com/night0721/cath" target = "_blank" > < img alt = 'Repo Stars' src = "https://img.shields.io/github/stars/night0721/cath?logo=github&color=555555&labelColor=02023a&style=for-the-badge" > < / a >
< a href = "https://ko-fi.com/I2I35XISJ" target = "_blank" > < img alt = 'Kofi' src = "https://img.shields.io/static/v1?label=Support%20Us&message=KO.FI&color=ff5e5b&logo=kofi&logoColor=white&style=for-the-badge&scale=1.4" > < / a >
< br >
< a href = "https://rebrand.ly/cathSupport" > < img src = "https://discordapp.com/api/guilds/718762019586572341/widget.png?style=banner2" alt = "Support Server" / > < / a >
< br >
< a href = "https://npmjs.org/package/cath" target = "_blank" > < img alt = 'Node Package' src = "https://nodei.co/npm/cath.png" > < / a >
< / p >
< p > < strong > Cath< / strong > is a powerful < a href = "https://nodejs.org" > Node.js< / a > module that can easily interact and get data from the Cath API
If you like this package, feel free to < img src = "https://discord.com/assets/141d49436743034a59dec6bd5618675d.svg" width = "16" > < strong > Star< / strong > and < strong > fork< / strong > this repository.< br > < br > < / p >
< a href = "#install-the-package-✔" id = "install-the-package-✔" style = "color: inherit; text-decoration: none;" >
< h1 > Install the package ✔< / h1 >
< / a >
< p > Download from npm< / p >
< pre > < code class = "language-cli" > npm install cath
< / code > < / pre >
< p > Download from yarn< / p >
< pre > < code class = "language-cli" > yarn add cath
< / code > < / pre >
< a href = "#examples" id = "examples" style = "color: inherit; text-decoration: none;" >
< h2 > Examples< / h2 >
< / a >
< a href = "#launch-of-the-module" id = "launch-of-the-module" style = "color: inherit; text-decoration: none;" >
< h3 > Launch of the module< / h3 >
< / a >
< pre > < code class = "language-js" > < span class = "hl-0" > const< / span > < span class = "hl-1" > < / span > < span class = "hl-2" > cath< / span > < span class = "hl-1" > = < / span > < span class = "hl-3" > require< / span > < span class = "hl-1" > (< / span > < span class = "hl-4" > " cath" < / span > < span class = "hl-1" > );< / span > < br / > < br / > < span class = "hl-0" > const< / span > < span class = "hl-1" > < / span > < span class = "hl-2" > reddit_data< / span > < span class = "hl-1" > = < / span > < span class = "hl-5" > await< / span > < span class = "hl-1" > < / span > < span class = "hl-6" > cath< / span > < span class = "hl-1" > .< / span > < span class = "hl-3" > getreddit< / span > < span class = "hl-1" > (< / span > < span class = "hl-4" > " meme" < / span > < span class = "hl-1" > );< / span > < br / > < span class = "hl-6" > console< / span > < span class = "hl-1" > .< / span > < span class = "hl-3" > log< / span > < span class = "hl-1" > (< / span > < span class = "hl-6" > reddit_data< / span > < span class = "hl-1" > ); < / span > < span class = "hl-7" > // returns an object< / span > < br / > < br / > < span class = "hl-0" > const< / span > < span class = "hl-1" > < / span > < span class = "hl-2" > answer< / span > < span class = "hl-1" > = < / span > < span class = "hl-5" > await< / span > < span class = "hl-1" > < / span > < span class = "hl-6" > cath< / span > < span class = "hl-1" > .< / span > < span class = "hl-3" > random8ball< / span > < span class = "hl-1" > ();< / span > < br / > < span class = "hl-6" > console< / span > < span class = "hl-1" > .< / span > < span class = "hl-3" > log< / span > < span class = "hl-1" > (< / span > < span class = "hl-6" > answer< / span > < span class = "hl-1" > ); < / span > < span class = "hl-7" > // a random answer from 8ball< / span >
< / code > < / pre >
< a href = "#support-feature-request-amp-bug-reports" id = "support-feature-request-amp-bug-reports" style = "color: inherit; text-decoration: none;" >
< h1 > Support, Feature Request & Bug Reports< / h1 >
< / a >
< a href = "#-support-amp-feature-request" id = "-support-amp-feature-request" style = "color: inherit; text-decoration: none;" >
< h2 > < img src = "https://cdn.discordapp.com/emojis/867093614403256350.png?v=1" width = 18 > Support & Feature Request< / h2 >
< / a >
< p > Join the official < a href = "https://discord.gg/SbQHChmGcp" > Support Server< / a > on Discord & we will be happy to assist you. < br >
To Request new features contact us on Discord using the support server.< / p >
< a href = "#-report-bugs" id = "-report-bugs" style = "color: inherit; text-decoration: none;" >
< h2 > < img src = "https://cdn.discordapp.com/emojis/867093601962950666.png?v=1" width = "18" > Report Bugs< / h2 >
< / a >
< p > You can report bugs or issues by opening a issue in this repository. Alternatevely you can also 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 >
2021-09-19 15:41:55 +02:00
< / 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 >
