dan/discord.js
1
0
Fork 0
mirror of https://github.com/danbulant/discord.js synced 2026-06-08 09:13:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Re-add docs

Browse source
This commit is contained in:
Schuyler Cebulskie 2017-11-20 01:13:36 -05:00
parent 1e0ee2f8fa
commit cf07b7e342
1 changed files with 13 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
src/util/Structures.js
View file

@ -1,5 +1,7 @@
/** /**
* Allows for the extension of built-in Discord.js structures that are instantiated by {@link DataStore DataStores}. * Allows for the extension of built-in Discord.js structures that are instantiated by {@link DataStore DataStores}.
* When extending a built-in structure, it is important to both get the class you're extending from here,
* and to set it here afterwards.
*/ */
class Structures { class Structures {
constructor() { constructor() {
@ -20,6 +22,17 @@ class Structures {
* Replaces a structure class with an extended one. * Replaces a structure class with an extended one.
* @param {string} structure Name of the structure to replace * @param {string} structure Name of the structure to replace
* @param {Function} extended Extended structure class/prototype function to replace with * @param {Function} extended Extended structure class/prototype function to replace with
* @example
* const { Structures } = require('discord.js');
*
* class CoolGuild extends Structures.get('Guild') {
* constructor(client, data) {
* super(client, data);
* this.cool = true;
* }
* }
*
* Structures.set('Guild', CoolGuild);
*/ */
static set(structure, extended) { static set(structure, extended) {
if (!structures[structure]) throw new RangeError(`"${structure}" is not a valid extensible structure.`); if (!structures[structure]) throw new RangeError(`"${structure}" is not a valid extensible structure.`);