Klasa

Creating Extendables

Extendables are functions that extend current Discord.js classes by adding methods or properties.

Extendables have the following syntax:

const { Extendable } = require('klasa');

module.exports = class extends Extendable {

	constructor(...args) {
		super(...args, ['Message'], {
			name: 'nameOfExtendable',
			enabled: true,
			klasa: false
		});
	}

// Getters

	get extend() {
		// Make a getter
	}

// Setters

	set extend() {
		// Make a setters
	}

// Methods

	extend() {
		// Make a methods
	}

};

Understanding extendable settings

constructor(...args) {
    super(...args, appliesTo, {
		name: 'nameOfExtendable', // default the file name
		enabled: true, // default true
		klasa: false // default false	
	);
}
Name Default Type Description
options.name theFileName string The name of the method/property
options.enabled true boolean If the extendable is enabled or not
options.klasa false boolean If the extendable is for Klasa instead of Discord.js
appliesTo [] Array An array of affected classes from Discord.js or Klasa.

You can find all extendable classes for Discord.js and Klasa in those respective links.

Understanding extend

The extend method can only be a setter, getter, or method. You cannot define multiple in one file as the above example may imply.

Examples

Imagine we want to extend the Message class so it has a method called prompt so you can do Message#prompt("Are you sure you want to continue?") everywhere in your code, resolving if the user confirms the prompt, or rejecting otherwise. Then, your extendable is likely to be like the following:

You can extend the Message object with this because you're likely to lock the prompt for a user in a channel, and Message has both properties of author and channel.

const { Extendable } = require('klasa');

module.exports = class extends Extendable {

	constructor(...args) {
		super(...args, ['Message'], { name: 'prompt' });
	}

	extend() {
		return prompt();
	}

};

Where prompt() is your prompt function.

Further Reading: