Skip to content

Commit db71bc7

Browse files
committed
fix(update): all package description
1 parent 780557b commit db71bc7

File tree

9 files changed

+9
-88
lines changed

9 files changed

+9
-88
lines changed

packages/ap/README.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,6 @@ The easy way to post your bots user, server and shard count stats.
99
## Supported Libraries
1010
```diff
1111
+ discord.js
12-
- detritus
13-
- discord-rose
14-
- eris
1512
```
1613

1714
---

packages/ap/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@infinitylist/ap",
3-
"description": "The easy way to post your bots user, server and shard count stats.",
3+
"description": "The easy way to post your bots user, server and shard count stats to the infinity api.",
44
"license": "MIT",
55
"main": "./dist/index.js",
66
"types": "./dist/index.d.ts",

packages/client/README.md

Lines changed: 0 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -3,82 +3,6 @@ Official NPM Client for our Autoposter Module!
33

44
---
55

6-
## Webhooks v1
7-
8-
### Available Data
9-
```
10-
{
11-
"bot": "string",
12-
"botID": "string",
13-
"test": false,
14-
"time": 0,
15-
"user": "string",
16-
"userID": "string",
17-
"userObj": {
18-
"avatar": "string",
19-
"bot": false,
20-
"discriminator": "string",
21-
"id": "string",
22-
"in_guild": "string",
23-
"nickname": "string",
24-
"status": "string",
25-
"username": "string"
26-
},
27-
"votes": 0
28-
}
29-
```
30-
31-
### Example Fastify Server
32-
33-
- For a basic server we created for you to use go [here](https://github.com/InfinityBotList/Webhook-Server)
34-
35-
```js
36-
const { MessageEmbed } = require("discord.js");
37-
const { Webhook } = require("@infinitybots/client");
38-
const moment = require("moment");
39-
40-
const webhook = new Webhook(`YOUR_WEBHOOK_SECRET`);
41-
42-
module.exports = async (fastify, opts) => {
43-
fastify.post(
44-
"/votes",
45-
webhook.hookListener(async (vote, req, res) => {
46-
47-
/** LOG MESSAGE TO DISCORD WITH VOTE DATA */
48-
let embed = new MessageEmbed()
49-
.setTitle(`Vote Logs`)
50-
.setColor("RANDOM")
51-
.setDescription(`Woah someone has voted for me on Infinity Bot List`)
52-
.addFields(
53-
{
54-
name: "Total Votes",
55-
value: `${vote.votes}`,
56-
inline: true,
57-
},
58-
{
59-
name: "User",
60-
value: `${vote.userObj.username}#${vote.userObj.discriminator}`,
61-
inline: true,
62-
},
63-
{
64-
name: "Time",
65-
value: `${moment(vote.timeStamp)}`,
66-
inline: true,
67-
}
68-
)
69-
.setTimestamp()
70-
.setFooter({
71-
text: "Infinity Vote Logger",
72-
iconURL: `${vote.userObj.avatar}`,
73-
});
74-
75-
})
76-
);
77-
};
78-
```
79-
80-
---
81-
826
## Webhooks v2
837

848
### Available Data

packages/client/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@infinitylist/client",
3-
"description": "Simple module for interacting with the infinity bot list api",
3+
"description": "Simple module for interacting with the infinity webhooks",
44
"license": "MIT",
55
"main": "./dist/index.js",
66
"types": "./dist/index.d.ts",

packages/emitter/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@infinitylist/emitter",
3-
"description": "Event emitter that creates types based off of an interface",
3+
"description": "Custom event emitter that creates types based off of an interface",
44
"license": "MIT",
55
"main": "dist/",
66
"version": "0.1.0",

packages/ipm/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@infinitylist/ipm",
3-
"description": "Infinity package manager, allows for offline installs and more using shrinkwrap and pacote",
3+
"description": "Infinity package manager!",
44
"license": "MIT",
55
"main": "dist/index.js",
66
"types": "./dist/logger.d.ts",

packages/logger/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@infinitylist/logger",
3-
"description": "Simple module for cleaner looking console logs",
3+
"description": "Simple module for somewhat cleaner looking console logs",
44
"license": "MIT",
55
"main": "./dist/logger.js",
66
"types": "./dist/logger.d.ts",

packages/sdk/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@infinitylist/sdk",
3-
"description": "Simple module for interacting with the infinity bot list api",
3+
"description": "Simple module for interacting with the infinity api",
44
"license": "MIT",
55
"main": "dist/index.js",
66
"types": "dist/index.d.ts",

packages/spider/src/base/Spider.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,11 +97,11 @@ export class SpiderClient extends EventEmitter {
9797
/**
9898
* ALERT BASED EVENTS
9999
*/
100-
public async getUserAlerts(id: Snowflake, query?: PageQuery): Promise<UserAlerts> {
100+
public async getUserAlerts(id: Snowflake, page?: PageQuery): Promise<UserAlerts> {
101101
if (!id) throw new Error('please provide a valid user id!')
102-
if (query && typeof query.page !== 'number') throw new Error('page should be a valid number')
102+
if (page && typeof page !== 'number') throw new Error('page should be a valid number')
103103

104-
return this._request('GET', `/users/${id}/alerts`, query).then((x: UserAlerts) => {
104+
return this._request('GET', `/users/${id}/alerts`, page).then((x: UserAlerts) => {
105105
return {
106106
count: x.count,
107107
per_page: x.per_page,

0 commit comments

Comments
 (0)