fix: type design has changed now

This commit is contained in:
ITOH
2021-05-04 13:04:36 +01:00
committed by GitHub
parent 8544a3e48c
commit 5b9f3e110b
+1 -4
View File
@@ -38,10 +38,9 @@
## Types Guide ## Types Guide
- Must use snake case (according to Discord API). - Must use camel case (same property name as in the docs just in camel case).
- Each field or property must be accompanied with a reasonable JSDoc comment - Each field or property must be accompanied with a reasonable JSDoc comment
right above its type definition. right above its type definition.
- The name of the type must be prefixed with `Discord`.
- Must be placed inside of the types module (in `src/types` directory). - Must be placed inside of the types module (in `src/types` directory).
Example: Example:
@@ -61,6 +60,4 @@ export interface User {
flags?: number; flags?: number;
premiumType?: number; premiumType?: number;
} }
export type DiscordUser = SnakeCasedPropertiesDeep<DiscordUserInternal>;
``` ```