discordjs-decorators
v2.1.0
Published
Bringing typescript decorators to discord.js
Downloads
5
Readme
Discord Decorators
This framework is made for users using typescript, I do not support the use of plain Javascript
This project is using typescript's decorator, you have to set the
experimentalDecorators
option totrue
in your tsconfig file.
Developer orientated discord.js
Framework based on Typescript.
Features
- Simple to use
- Powerful
- A lot of configuration possible
Getting Started
Please look here for details on how to get running on a dev environment.
Prerequisites
What things you need to install the software and how to install them
npm i discord.js --save
Installing
Install with
npm i discordjs-decorators --save # yarn add discordjs-decorators
and install discord.js
npm i discord.js --save # yarn add discord.js
You can now use discordjs-decorators
in your project.
Running the tests
Unit tests
yarn only-test
Code style
yarn lint
Implementation tests
Important: You need to setup a config(.js) file in the
test
folder which exports a JSON object with a token and owner property.
yarn test:discord
Built With
Contributing
Please read CONTRIBUTING.md for details.
License
This project is licensed under the GNU General Public License v2.0.
Acknowledgments
This project is inspired by yamdbf.