You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+18-18
Original file line number
Diff line number
Diff line change
@@ -2,39 +2,39 @@
2
2
3
3
**The issue tracker is only for bug reports and enhancement suggestions. If you have a question, please ask it in the [Discord server](https://discord.gg/djs) instead of opening an issue, or on [GitHub Discussions](https://github.com/discordjs/discord-api-types/discussions) – you will get redirected there anyway.**
4
4
5
-
-[Code of Conduct](https://github.com/discordjs/discord-api-types/blob/main/.github/CODE_OF_CONDUCT.md)
-Checkout a topic branch from a base branch, e.g. `main`, and merge back against that branch.
13
+
- Checkout a topic branch from a base branch, e.g. `main`, and merge back against that branch.
14
14
15
-
-If adding a new feature:
15
+
- If adding a new feature:
16
16
17
-
-Provide a convincing reason to add this feature. Ideally, you should open a suggestion issue first and have it approved before working on it.
17
+
- Provide a convincing reason to add this feature. Ideally, you should open a suggestion issue first and have it approved before working on it.
18
18
19
-
-If fixing a bug:
19
+
- If fixing a bug:
20
20
21
-
-If you are resolving a special issue, add `fix/close #xxxx[,#xxxx]` (#xxxx is the issue id) in your PR body for a better release log, e.g.
21
+
- If you are resolving a special issue, add `fix/close #xxxx[,#xxxx]` (#xxxx is the issue id) in your PR body for a better release log, e.g.
22
22
23
23
```
24
24
fix(Guild): handle events correctly
25
25
26
26
close #28
27
27
```
28
28
29
-
- Provide a detailed description of the bug in the PR. Live demo preferred.
29
+
- Provide a detailed description of the bug in the PR. Live demo preferred.
30
30
31
-
- It's OK to have multiple small commits as you work on the PR - GitHub can automatically squash them before merging.
31
+
- It's OK to have multiple small commits as you work on the PR - GitHub can automatically squash them before merging.
32
32
33
-
- Make sure tests pass!
33
+
- Make sure tests pass!
34
34
35
-
- Commit messages must follow the [commit message convention](./COMMIT_CONVENTION.md) so that changelogs can be automatically generated. Commit messages are automatically validated before commit (by invoking [Git Hooks](https://git-scm.com/docs/githooks) via [husky](https://github.com/typicode/husky)).
35
+
- Commit messages must follow the [commit message convention](./COMMIT_CONVENTION.md) so that changelogs can be automatically generated. Commit messages are automatically validated before commit (by invoking [Git Hooks](https://git-scm.com/docs/githooks) via [husky](https://github.com/typicode/husky)).
36
36
37
-
- No need to worry about code style as long as you have installed the dev dependencies - modified files are automatically formatted with Prettier on commit (by invoking [Git Hooks](https://git-scm.com/docs/githooks) via [husky](https://github.com/typicode/husky)).
37
+
- No need to worry about code style as long as you have installed the dev dependencies - modified files are automatically formatted with Prettier on commit (by invoking [Git Hooks](https://git-scm.com/docs/githooks) via [husky](https://github.com/typicode/husky)).
38
38
39
39
## Development Setup
40
40
@@ -48,6 +48,6 @@ $ npm i # install the dependencies of the project
48
48
49
49
A high level overview of tools used:
50
50
51
-
-[TypeScript](https://www.typescriptlang.org/) as the development language
52
-
-[ESLint](https://eslint.org/) for code-style
53
-
-[Prettier](https://prettier.io/) for code formatting
51
+
-[TypeScript](https://www.typescriptlang.org/) as the development language
52
+
-[ESLint](https://eslint.org/) for code-style
53
+
-[Prettier](https://prettier.io/) for code formatting
Copy file name to clipboardExpand all lines: README.md
+10-10
Original file line number
Diff line number
Diff line change
@@ -77,25 +77,25 @@ import { APIUser } from 'https://cdn.skypack.dev/discord-api-types/v10?dts';
77
77
78
78
The exports of each API version is split into three main parts:
79
79
80
-
-Everything exported with the `API` prefix represents a payload you may get from the REST API _or_ the Gateway.
80
+
- Everything exported with the `API` prefix represents a payload you may get from the REST API _or_ the Gateway.
81
81
82
-
-Everything exported with the `Gateway` prefix represents data that ONLY comes from or is directly related to the Gateway.
82
+
- Everything exported with the `Gateway` prefix represents data that ONLY comes from or is directly related to the Gateway.
83
83
84
-
-Everything exported with the `REST` prefix represents data that ONLY comes from or is directly related to the REST API.
84
+
- Everything exported with the `REST` prefix represents data that ONLY comes from or is directly related to the REST API.
85
85
86
-
-For endpoint options, they will follow the following structure: `REST<HTTP Method><Type><Query|(JSON|FormData)Body|Result>` where the type represents what it will return.
86
+
- For endpoint options, they will follow the following structure: `REST<HTTP Method><Type><Query|(JSON|FormData)Body|Result>` where the type represents what it will return.
87
87
88
-
-For example, `RESTPostAPIChannelMessageJSONBody` or `RESTGetAPIGatewayBotInfoResult`.
88
+
- For example, `RESTPostAPIChannelMessageJSONBody` or `RESTGetAPIGatewayBotInfoResult`.
89
89
90
-
-Some exported types (specifically OAuth2 related ones) may not respect this entire structure due to the nature of the fields. They will start with either `RESTOAuth2` or with something similar to `REST<HTTP Method>OAuth2`
90
+
- Some exported types (specifically OAuth2 related ones) may not respect this entire structure due to the nature of the fields. They will start with either `RESTOAuth2` or with something similar to `REST<HTTP Method>OAuth2`
91
91
92
-
-If a type ends with `Result`, then it represents the expected result by calling its accompanying route.
92
+
- If a type ends with `Result`, then it represents the expected result by calling its accompanying route.
93
93
94
-
-Types that are exported as `never` usually mean the result will be a `204 No Content`, so you can safely ignore it. This does **not** account for errors.
94
+
- Types that are exported as `never` usually mean the result will be a `204 No Content`, so you can safely ignore it. This does **not** account for errors.
95
95
96
-
-Anything else that is miscellaneous will be exported based on what it represents (for example the `REST` route object).
96
+
- Anything else that is miscellaneous will be exported based on what it represents (for example the `REST` route object).
97
97
98
-
-There may be types exported that are identical for all versions. These will be exported as is and can be found in the `globals` file. They will still be prefixed accordingly as described above.
98
+
- There may be types exported that are identical for all versions. These will be exported as is and can be found in the `globals` file. They will still be prefixed accordingly as described above.
99
99
100
100
**A note about how types are documented**: This package will add types only for known and documented properties that are present in Discord's [API Documentation repository](https://github.com/discord/discord-api-docs),
101
101
that are mentioned in an open pull request, or known through other means _and have received the green light to be used_.
Copy file name to clipboardExpand all lines: deno/README.md
+10-10
Original file line number
Diff line number
Diff line change
@@ -77,25 +77,25 @@ import { APIUser } from 'https://cdn.skypack.dev/discord-api-types/v10?dts';
77
77
78
78
The exports of each API version is split into three main parts:
79
79
80
-
-Everything exported with the `API` prefix represents a payload you may get from the REST API _or_ the Gateway.
80
+
- Everything exported with the `API` prefix represents a payload you may get from the REST API _or_ the Gateway.
81
81
82
-
-Everything exported with the `Gateway` prefix represents data that ONLY comes from or is directly related to the Gateway.
82
+
- Everything exported with the `Gateway` prefix represents data that ONLY comes from or is directly related to the Gateway.
83
83
84
-
-Everything exported with the `REST` prefix represents data that ONLY comes from or is directly related to the REST API.
84
+
- Everything exported with the `REST` prefix represents data that ONLY comes from or is directly related to the REST API.
85
85
86
-
-For endpoint options, they will follow the following structure: `REST<HTTP Method><Type><Query|(JSON|FormData)Body|Result>` where the type represents what it will return.
86
+
- For endpoint options, they will follow the following structure: `REST<HTTP Method><Type><Query|(JSON|FormData)Body|Result>` where the type represents what it will return.
87
87
88
-
-For example, `RESTPostAPIChannelMessageJSONBody` or `RESTGetAPIGatewayBotInfoResult`.
88
+
- For example, `RESTPostAPIChannelMessageJSONBody` or `RESTGetAPIGatewayBotInfoResult`.
89
89
90
-
-Some exported types (specifically OAuth2 related ones) may not respect this entire structure due to the nature of the fields. They will start with either `RESTOAuth2` or with something similar to `REST<HTTP Method>OAuth2`
90
+
- Some exported types (specifically OAuth2 related ones) may not respect this entire structure due to the nature of the fields. They will start with either `RESTOAuth2` or with something similar to `REST<HTTP Method>OAuth2`
91
91
92
-
-If a type ends with `Result`, then it represents the expected result by calling its accompanying route.
92
+
- If a type ends with `Result`, then it represents the expected result by calling its accompanying route.
93
93
94
-
-Types that are exported as `never` usually mean the result will be a `204 No Content`, so you can safely ignore it. This does **not** account for errors.
94
+
- Types that are exported as `never` usually mean the result will be a `204 No Content`, so you can safely ignore it. This does **not** account for errors.
95
95
96
-
-Anything else that is miscellaneous will be exported based on what it represents (for example the `REST` route object).
96
+
- Anything else that is miscellaneous will be exported based on what it represents (for example the `REST` route object).
97
97
98
-
-There may be types exported that are identical for all versions. These will be exported as is and can be found in the `globals` file. They will still be prefixed accordingly as described above.
98
+
- There may be types exported that are identical for all versions. These will be exported as is and can be found in the `globals` file. They will still be prefixed accordingly as described above.
99
99
100
100
**A note about how types are documented**: This package will add types only for known and documented properties that are present in Discord's [API Documentation repository](https://github.com/discord/discord-api-docs),
101
101
that are mentioned in an open pull request, or known through other means _and have received the green light to be used_.
![renovate[bot]](https://avatars.githubusercontent.com/in/2740?v=4&size=40){kind=avatar}
0 commit comments