Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Redo documentation #63

Merged
merged 6 commits into from
Jul 1, 2021
Merged

Redo documentation #63

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
82d1b35
docs
jpbberry Jun 20, 2021
0f4463b
Merge branch 'top-gg:master' into master
jpbberry Jun 21, 2021
e40181c
Bump & remove useless things in package
jpbberry Jun 21, 2021
b795c83
Remove github workflow since we're moving to netlify
jpbberry Jun 29, 2021
68baa3d
Revert breaking change
jpbberry Jul 1, 2021
1296a45
Improve documentation links
jpbberry Jul 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Improve documentation links
  • Loading branch information
@jpbberry
jpbberry committed Jul 1, 2021
commit 1296a45a24dc91766e69c5ed1064b45583e08696
4 changes: 2 additions & 2 deletions src/structs/Api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ interface APIOptions {
*
* const api = new Topgg.Api('Your top.gg token')
* ```
* @link https://topgg.js.org <- Library docs
* @link https://docs.top.gg <- API Reference
* @link {@link https://topgg.js.org | Library docs}
* @link {@link https://docs.top.gg | API Reference}
*/
export class Api extends EventEmitter {
private options: APIOptions;
Expand Down
6 changes: 4 additions & 2 deletions src/structs/Webhook.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ export interface WebhookOptions {
* // URL = http://your.server.ip:80/dblwebhook
* // Authorization: webhookauth123
* ```
* @link {@link https://docs.top.gg/resources/webhooks/#schema | Webhook Data Schema}
* @link {@link https://docs.top.gg/resources/webhoooks | Webhook Documentation}
*/
export class Webhook {
public options: WebhookOptions;
Expand Down Expand Up @@ -132,8 +134,8 @@ export class Webhook {
}

/**
* (Use the new .listener() function) Middleware function to pass to express, sets req.vote to the payload
* @deprecated
* Middleware function to pass to express, sets req.vote to the payload
* @deprecated Use the new {@link Webhook.listener | .listener()} function
* @example
* ```js
* app.post('/dblwebhook', wh.middleware(), (req, res) => {
Expand Down