# kyusei

> A DiscordJS utility library!

Latest version **0.4.10-PATCH** (published 2022-11-06) · unlicense license · 0 weekly downloads

## Install

```sh
npm install kyusei
pnpm add kyusei
yarn add kyusei
bun add kyusei
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.10-PATCH |
| Published | 2022-11-06 |
| First published | 2022-10-22 |
| Weekly downloads | 0 |
| License | unlicense |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 45.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| Author | AceLikesGhosts |
| Maintainers | acelikesghosts |
| Keywords | utility, discordjs |

## Links

- npm: https://www.npmjs.com/package/kyusei
- Repository: https://github.com/acelikesghosts/kyusei
- Homepage: https://acelikesghosts.github.io/kyusei
- Issues: https://github.com/acelikesghosts/kyusei/issues
- npm.io page: https://npm.io/package/kyusei

## Dependencies (4)

- [chalk](https://npm.io/package/chalk.md) ^4.0.0
- [tslib](https://npm.io/package/tslib.md) ^2.4.1
- [discord.js](https://npm.io/package/discord.js.md) ^14.6.0
- [reflect-metadata](https://npm.io/package/reflect-metadata.md) ^0.1.13

## Alternatives

- [lodash.assign](https://npm.io/package/lodash.assign.md) — 2.3M weekly downloads
- [lodash.chunk](https://npm.io/package/lodash.chunk.md) — 1.8M weekly downloads
- [react-native-ios-utilities](https://npm.io/package/react-native-ios-utilities.md) — 138.5K weekly downloads
- [@technically/lodash](https://npm.io/package/@technically/lodash.md) — 50.9K weekly downloads
- [@fluid-topics/ft-icon](https://npm.io/package/@fluid-topics/ft-icon.md) — 20.6K weekly downloads

## Recent versions

- 0.4.10-PATCH (latest) — 2022-11-06
- 0.4.10 — 2022-11-06
- 0.4.9-PATCH — 2022-11-05
- 0.4.8 — 2022-11-05
- 0.4.7 — 2022-11-05
- 0.4.6 — 2022-11-03
- 0.3.6 — 2022-11-02
- 0.3.5 — 2022-10-31
- 0.3.4 — 2022-10-31
- 0.3.3 — 2022-10-31
- 0.3.2 — 2022-10-30
- 0.3.1 — 2022-10-30
- 0.3.0 — 2022-10-30
- 0.2.9 — 2022-10-29
- 0.2.8 — 2022-10-29
- … 11 more at https://npm.io/package/kyusei/versions

## README

# kyusei
- Kyusei or 急性 means "acute", there is no reason behind this name, it just sounds nice!

---

kyusei is a [Discord.JS](https://github.com/discordjs/discord.js/) 
utility framework, written in Typescript which aims to 
make Commands and Events easier by providing annotations/decorators for them.

# Documentation
At this current point there is not any "officially" written documentation, although that will be covered eventually, there is Typedoc-based documentation which can be found [here](https://acelikesghosts.github.io/kyusei/) 


# Examples
For more in depth examples, please refer to the `/examples` folder, or click [here](https://github.com/AceLikesGhosts/kyusei/tree/master/examples).

For a basic example of using Kyusei for commands:
```ts
// index.ts
import Kyu from 'kyusei';

const client: Kyu<true> = new Kyu({ 
    // Your intents, partials, and other Discord.JS data,
    commands: {
        path: join(__dirname, 'commands')
    }
});

client.init('token');

// commands/ExampleCommand.ts
import { Command, CommandBase } from 'kyusei';
import { ChatInputCommandInteraction, CacheType } from 'discord.js';

@Command({ name: 'Example', description: 'A basic command' })
export default class ExampleCommand implements CommandBase
{
    public execute(interaction: ChatInputCommandInteraction<CacheType>)
    {
        interaction.reply('Example command ran!');
    }
}
```

## Publishing
If you have permission to publish, then go ahead and run `npm publish` and increment the version number, please push the version change as well.

### This project relies heavily upon:
- Reflect-Metadata
- Discord.JS

---
_Source: https://npm.io/package/kyusei · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._