@sapphire/decorators
Useful TypeScript decorators for Sapphire Framework bots.
Description
Decorators can add a lot of functionality with very minimal code. This package provides some common decorators that can be used with projects using the Sapphire Framework.
Installation
@sapphire/decorators depends on the following packages. Be sure to install these along with this package!
You can use the following command to install this package, or replace npm install with your package manager of choice.
npm install @sapphire/decorators @sapphire/discord.js-utilities @sapphire/utilities @sapphire/framework discord.js
Buy us some doughnuts
Sapphire Community is and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!
We accept donations through Open Collective, Ko-fi, Paypal, Patreon and GitHub Sponsorships. You can use the buttons below to donate through your method of choice.
| Donate With | Address |
|---|---|
| Open Collective | Click Here |
| Ko-fi | Click Here |
| Patreon | Click Here |
| PayPal | Click Here |
Contributors
Please make sure to read the Contributing Guide before making a pull request.
Thank you to all the people who already contributed to Sapphire!
Enumerations
| Enumeration | Description |
|---|---|
| DecoratorIdentifiers | - |
Interfaces
| Interface | Description |
|---|---|
| ApplyOptionsCallbackParameters | - |
| FunctionFallback | The fallback interface, this is called when the function precondition returns or resolves with a falsy value. |
| FunctionPrecondition | The function precondition interface. |
Functions
| Function | Description |
|---|---|
| ApplyOptions | Decorator function that applies given options to any Sapphire piece |
| createClassDecorator | Utility to make a class decorator with lighter syntax and inferred types. |
| createFunctionPrecondition | Utility to make function preconditions. |
| createMethodDecorator | Utility to make a method decorator with lighter syntax and inferred types. |
| Enumerable | Decorator that sets the enumerable property of a class field to the desired value. |
| EnumerableMethod | Decorator that sets the enumerable property of a class method to the desired value. |
| RequiresClientPermissions | Allows you to set permissions required for individual methods. This is particularly useful for subcommands that require specific permissions. |
| RequiresDMContext | Requires the message to be run in a dm context, this decorator requires the first argument to be a Message or BaseInteraction instance which includes all interaction types |
| RequiresGuildContext | Requires the message to be run in a guild context, this decorator requires the first argument to be a Message or BaseInteraction instance which includes all interaction types |
| RequiresUserPermissions | Allows you to set permissions required for individual methods. This is particularly useful for subcommands that require specific permissions. |