https://github.com/MeguminSama/discord-slash-commands

Node.JS Slash Commands for Discord
https://github.com/MeguminSama/discord-slash-commands

hacktoberfest

Last synced: 2 months ago
JSON representation

Node.JS Slash Commands for Discord

• Host: GitHub
• URL: https://github.com/MeguminSama/discord-slash-commands
• Owner: MeguminSama
• License: mit
• Created: 2020-12-10T21:18:04.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-05-03T08:18:57.000Z (5 months ago)
• Last Synced: 2024-07-16T18:12:33.881Z (2 months ago)
• Topics: hacktoberfest
• Language: TypeScript
• Homepage:
• Size: 107 KB
• Stars: 100
• Watchers: 2
• Forks: 15
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• discord-api-libs - discord-slash-commands - Node.JS Slash Commands for Discord (Libraries / TypeScript)

README

        
# discord-slash-commands

This package provides Slash command support for the new Discord Interactions API.

[![npm](https://img.shields.io/npm/v/slash-commands?color=red)](https://www.npmjs.com/package/slash-commands)

[![npm bundle size](https://img.shields.io/bundlephobia/min/slash-commands)](https://www.npmjs.com/package/slash-commands)

[![npm downloads](https://img.shields.io/npm/dt/slash-commands?color=blue)](https://www.npmjs.com/package/slash-commands)

We've documented every type used by the interactions API, so you can make use of this library in your own projects, or make use of the utility functions we've provided to create, get, and delete slash commands.

## Installation

This is a [Node.js](https://nodejs.org/en/) module available from the [npm registry](https://www.npmjs.com/package/slash-commands).

You can install it with npm

```bash

npm install slash-commands

```

or with Yarn

```bash

yarn add slash-commands

```

## Importing

To import:

```ts

import { DiscordInteractions } from "slash-commands";

```

or

```js

const { DiscordInteractions } = require("slash-commands");

```

## Initialization

```js

const interaction = new DiscordInteractions({

  applicationId: "1234567890",

  authToken: "bot token",

  publicKey: "discord-provided public key",

});

```

## Usage

> The following examples use `496279654483886100` as a guild id and `545581357812678656` as a command id

### Getting Commands

```js

// Get Global Commands

await interaction

  .getApplicationCommands()

  .then(console.log)

  .catch(console.error);

// Get Guild Commands

await interaction

  .getApplicationCommands("496279654483886100")

  .then(console.log)

  .catch(console.error);

```

### Creating Commands

```js

const command = {

  name: "avatar",

  description: "get a users avatar",

  options: [

    {

      name: "big",

      description: "should the image be big",

      type: ApplicationCommandOptionType.BOOLEAN,

    },

  ],

};

// Create Global Command

await interaction

  .createApplicationCommand(command)

  .then(console.log)

  .catch(console.error);

// Create Guild Command

await interaction

  .createApplicationCommand(command, "496279654483886100")

  .then(console.log)

  .catch(console.error);

```

### Editing Commands

```js

const command = {

  name: "avatar",

  description: "get a users avatar",

  options: [

    {

      name: "small",

      description: "should the image be small",

      type: ApplicationCommandOptionType.BOOLEAN,

    },

  ],

};

// Edit Global Command

await interaction

  .createApplicationCommand(command, null, "545581357812678656")

  .then(console.log)

  .catch(console.error);

// Edit Guild Command

await interaction

  .createApplicationCommand(command, "496279654483886100", "545581357812678656")

  .then(console.log)

  .catch(console.error);

```

### Deleting Commands

```js

// Delete Global Command

await interaction

  .deleteApplicationCommand("545581357812678656")

  .then(console.log)

  .catch(console.error);

// Delete Guild Command

await interaction

  .deleteApplicationCommand("545581357812678656", "496279654483886100")

  .then(console.log)

  .catch(console.error);

```

## Disclaimer

The slash command API is incomplete, so this library is likely to have breaking changes on non-major releases.

Once the slash command API is stable, we will bump the project to v2.0.0.

## Contributing

Help is much-needed to improve the library and add all features. Please feel free to make a PR to [the repository](https://github.com/MeguminSama/discord-slash-commands).