fix(website): discord-api-types links, URL links and some minor doc issues (#9990)

* fix(website): correctly link to discord-api-types in link tags

* fix: url links and some minor doc issues

* fix: unneeded import

* fix: another unneccessary import

* fix: several linting issues

* refactor: simplify ApiItemLike interface

* refactor: apply suggestions

* fix: missing newline in docComment

---------

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
This commit is contained in:
Qjuh
2023-11-22 09:26:43 +01:00
committed by GitHub
parent e9ff99101b
commit 57c414be21
8 changed files with 146 additions and 95 deletions

View File

@@ -19,11 +19,11 @@ class BaseClient extends EventEmitter {
throw new DiscordjsTypeError(ErrorCodes.InvalidType, 'options', 'object', true);
}
const defaultOptions = Options.createDefault();
/**
* The options the client was instantiated with
* @type {ClientOptions}
*/
const defaultOptions = Options.createDefault();
this.options = {
...defaultOptions,
...options,

View File

@@ -16,7 +16,7 @@ class ClientVoiceManager {
Object.defineProperty(this, 'client', { value: client });
/**
* Maps guild ids to voice adapters created for use with @discordjs/voice.
* Maps guild ids to voice adapters created for use with `@discordjs/voice`.
* @type {Map<Snowflake, Object>}
*/
this.adapters = new Map();

View File

@@ -1405,7 +1405,7 @@ class Guild extends AnonymousGuild {
}
/**
* The voice state adapter for this guild that can be used with @discordjs/voice to play audio in voice
* The voice state adapter for this guild that can be used with `@discordjs/voice` to play audio in voice
* and stage channels.
* @type {Function}
* @readonly

View File

@@ -8,7 +8,7 @@ const { DiscordjsTypeError, ErrorCodes } = require('../errors');
/**
* @typedef {Function} GlobalSweepFilter
* @returns {?Function} Return `null` to skip sweeping, otherwise a function passed to `sweep()`,
* See {@link [Collection#sweep](https://discord.js.org/docs/packages/collection/stable/Collection:Class#sweep)}
* See {@link https://discord.js.org/docs/packages/collection/stable/Collection:Class#sweep Collection#sweep}
* for the definition of this function.
*/