2022-01-08 05:18:25 +13:00
< div align = "center" >
< br / >
< p >
< a href = "https://discord.js.org" > < img src = "https://discord.js.org/static/logo.svg" width = "546" alt = "discord.js" / > < / a >
< / p >
< br / >
2022-07-20 04:26:03 +12:00
< p >
2022-01-08 05:18:25 +13:00
< a href = "https://discord.gg/djs" > < img src = "https://img.shields.io/discord/222078108977594368?color=5865F2&logo=discord&logoColor=white" alt = "Discord server" / > < / a >
< a href = "https://www.npmjs.com/package/@discordjs/builders" > < img src = "https://img.shields.io/npm/v/@discordjs/builders.svg?maxAge=3600" alt = "npm version" / > < / a >
< a href = "https://www.npmjs.com/package/@discordjs/builders" > < img src = "https://img.shields.io/npm/dt/@discordjs/builders.svg?maxAge=3600" alt = "npm downloads" / > < / a >
2022-01-10 07:35:18 +13:00
< a href = "https://github.com/discordjs/discord.js/actions" > < img src = "https://github.com/discordjs/discord.js/actions/workflows/test.yml/badge.svg" alt = "Build status" / > < / a >
2022-07-05 00:00:27 +12:00
< a href = "https://codecov.io/gh/discordjs/discord.js" > < img src = "https://codecov.io/gh/discordjs/discord.js/branch/main/graph/badge.svg?precision=2&flag=builders" alt = "Code coverage" / > < / a >
2022-01-08 05:18:25 +13:00
< / p >
2022-07-20 04:26:03 +12:00
< p >
2022-07-24 09:38:49 +12:00
< a href = "https://vercel.com/?utm_source=discordjs&utm_campaign=oss" > < img src = "https://raw.githubusercontent.com/discordjs/discord.js/main/.github/powered-by-vercel.svg" alt = "Vercel" / > < / a >
2023-05-06 06:29:10 +12:00
< a href = "https://www.cloudflare.com" > < img src = "https://raw.githubusercontent.com/discordjs/discord.js/main/.github/powered-by-workers.png" alt = "Cloudflare Workers" height = "44" / > < / a >
2022-07-20 04:26:03 +12:00
< / p >
2022-01-08 05:18:25 +13:00
< / div >
2023-04-02 00:45:15 +13:00
## About
2023-04-20 18:25:32 +12:00
`@discordjs/builders` is a utility package for easily building Discord API payloads.
2023-04-02 00:45:15 +13:00
2022-01-08 05:18:25 +13:00
## Installation
2023-08-14 07:49:33 +12:00
**Node.js 16.11.0 or newer is required.**
2022-01-08 05:18:25 +13:00
2023-03-24 10:17:41 +13:00
```sh
2022-01-08 05:18:25 +13:00
npm install @discordjs/builders
yarn add @discordjs/builders
pnpm add @discordjs/builders
```
## Examples
2023-04-02 00:45:15 +13:00
You can find examples of how to use the builders in the [Slash Command Builders][example] examples.
2022-01-08 05:18:25 +13:00
## Links
2022-10-09 04:55:01 +13:00
- [Website][website] ([source][website-source])
- [Documentation][documentation]
- [Guide][guide] ([source][guide-source])
2023-04-02 00:45:15 +13:00
Also see the v13 to v14 [Update Guide][guide-update], which includes updated and removed items from the library.
2022-10-09 04:55:01 +13:00
- [discord.js Discord server][discord]
- [Discord API Discord server][discord-api]
- [GitHub][source]
- [npm][npm]
- [Related libraries][related-libs]
2022-01-08 05:18:25 +13:00
## Contributing
Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the
2022-10-09 04:55:01 +13:00
[documentation][documentation].
See [the contribution guide][contributing] if you'd like to submit a PR.
2022-01-08 05:18:25 +13:00
## Help
2023-04-02 00:45:15 +13:00
If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
2022-10-09 04:55:01 +13:00
[example]: https://github.com/discordjs/discord.js/blob/main/packages/builders/docs/examples/Slash%20Command%20Builders.md
2023-04-02 00:45:15 +13:00
[website]: https://discord.js.org
2022-10-10 12:22:48 +13:00
[website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website
2023-04-02 00:45:15 +13:00
[documentation]: https://discord.js.org/docs/packages/builders/stable
2022-10-09 04:55:01 +13:00
[guide]: https://discordjs.guide/
[guide-source]: https://github.com/discordjs/guide
[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html
[discord]: https://discord.gg/djs
[discord-api]: https://discord.gg/discord-api
[source]: https://github.com/discordjs/discord.js/tree/main/packages/builders
[npm]: https://www.npmjs.com/package/@discordjs/builders
[related-libs]: https://discord.com/developers/docs/topics/community-resources#libraries
[contributing]: https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md