This repository was archived by the owner on Jul 30, 2022. It is now read-only.
Add tsdoc on structures #33
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Mesteery
suggested changes
Jun 19, 2021
| import type { DeepRequired } from '../utils'; | ||
| import { GatewayException } from '../exceptions'; | ||
| import { BaseClient } from './BaseClient'; | ||
| import type { HttpOptions } from '../http'; |
Contributor
There was a problem hiding this comment.
Can you revet imports order changes?
| /** | ||
| * Discord's gateway version. | ||
| * @default 8 | ||
| * @defaultValue 8 |
Contributor
There was a problem hiding this comment.
defaultValue `8` or defaultValue 8 ?
| import { deconstruct } from '../utils/Snowflake'; | ||
| import { Team } from './team/Team'; | ||
| import { User } from './User'; | ||
|
|
Contributor
There was a problem hiding this comment.
Can you explain why and when some fields can be nullable?
| import { GuildChannel } from './channel/GuildChannel'; | ||
| import { Guild } from './guild/Guild'; | ||
| import { User } from './User'; | ||
|
|
Contributor
There was a problem hiding this comment.
Same about nullable fields.
Mesteery
suggested changes
Jun 19, 2021
| /** | ||
| * The user(s) of the DM | ||
| */ | ||
| public recipients = new Collection<Snowflake, User>(); |
| */ | ||
| public author?: User; | ||
|
|
||
| public $patch(data: APIEmoji): void { |
Mesteery
added
doc
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.