cordbuilder
TypeScript icon, indicating that this package has built-in type declarations

0.1.7 • Public • Published

📦 cordbuilder

Cord Builder is a library that provides a Domain Specific Language (DSL) for creating builders for Discord.js. Currently, it supports the creation of buttons.

Note: For syntax highlighting and code snippets, you can use the CordBuilder extension. It's available on the Visual Studio Code Marketplace

🚀 Installation

To install the library, you can use npm or yarn:

npm install cordbuilder
yarn add cordbuilder

ℹ️ Usage

✅ Button

The source should follow this format:

  • @label?: string
  • @style: Primary | Secondary | Success | Danger | Link
  • @id?: string
  • @emoji?: string
  • @disabled?: true | false
  • @url?: url

✅ Embed

The source should follow this format:

Author

  • @author [
    • :name string,
    • :url url,
    • :icon url
  • ]

Fields

  • @field [
    • :name string,
    • :value string,
    • :inline? true| false
  • ]

Footer

  • @footer [
    • :text string,
    • :icon url
  • ]

Others

  • @title: string
  • @thumbnail: url
  • @image: url
  • @color: color | hex | random
  • @description: string

🪐 Contributing

We encourage contributions! Feel free to open an issue or submit a pull request.

📜 License

This project is licensed under the MIT License.

Package Sidebar

Install

npm i cordbuilder

Weekly Downloads

91

Version

0.1.7

License

ISC

Unpacked Size

53.8 kB

Total Files

40

Last publish

Collaborators

  • drezzyts