search

discordjs / RPC

A simple RPC client for Discord
MIT License
466 stars 191 forks source link

docs: improve documentation #90

Open NotSugden opened 3 years ago

NotSugden commented 3 years ago

This PR adds some better documentation, corrects some invalid syntax in the JSDoc comments, and deprecates RPCClient#sendJoinRequest as the command has been removed

this PR only changes documentation

reference: this pr is apart of the chain of prs requested from https://github.com/discordjs/RPC/pull/89#issuecomment-693537755

NotSugden commented 3 years ago

Updated to requested changes, however there is just a nit - the VoiceSettings and UserVoiceSettings typedefs have properties marked as optional (for editing via any of the respective set* methods), but the same type is used as the return type - this would be incorrect as the properties will not be optional, not really sure of the best way to go about that or if it should even be addressed

papaia commented 3 years ago

Shouldn't Promise<undefined> be changed to Promise<void>?

NotSugden commented 3 years ago

Shouldn't Promise<undefined> be changed to Promise<void>?

thats what i thought, but https://github.com/discordjs/RPC/pull/90#discussion_r489948941

dscalzi commented 3 years ago

Could throw in an index.d.ts while you're at it.

NotSugden commented 3 years ago

Could throw in an index.d.ts while you're at it.

see https://github.com/discordjs/RPC/pull/89#issuecomment-693537755 snek doesn't want typings in the library itself