Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-17 03:53:29 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: ignore docs of unexported functions (#8051)

Browse Source
This commit is contained in:
Almeida
2022-06-09 12:58:42 +01:00
committed by GitHub
parent eea139b346
commit 94bdcaca62
1 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
packages/discord.js/src/errors/DJSError.js
View File

@@ -9,6 +9,7 @@ const messages = new Map();
* Extend an error of some sort into a DiscordjsError. * Extend an error of some sort into a DiscordjsError.
* @param {Error} Base Base error to extend * @param {Error} Base Base error to extend
* @returns {DiscordjsError} * @returns {DiscordjsError}
* @ignore
*/ */
function makeDiscordjsError(Base) { function makeDiscordjsError(Base) {
return class DiscordjsError extends Base { return class DiscordjsError extends Base {
@@ -33,6 +34,7 @@ function makeDiscordjsError(Base) {
* @param {string} key Error key * @param {string} key Error key
* @param {Array<*>} args Arguments to pass for util format or as function args * @param {Array<*>} args Arguments to pass for util format or as function args
* @returns {string} Formatted string * @returns {string} Formatted string
* @ignore
*/ */
function message(key, args) { function message(key, args) {
if (typeof key !== 'string') throw new Error('Error message key must be a string'); if (typeof key !== 'string') throw new Error('Error message key must be a string');
@@ -48,6 +50,7 @@ function message(key, args) {
* Register an error code and message. * Register an error code and message.
* @param {string} sym Unique name for the error * @param {string} sym Unique name for the error
* @param {*} val Value of the error * @param {*} val Value of the error
* @ignore
*/ */
function register(sym, val) { function register(sym, val) {
messages.set(sym, typeof val === 'function' ? val : String(val)); messages.set(sym, typeof val === 'function' ? val : String(val));