#twilight #discord #discord-api

sparkle_interactions

为 Twilight 提供安全、简洁的 Discord 交互处理

4 个版本

0.15.3 2024 年 7 月 25 日
0.15.2 2024 年 6 月 10 日
0.15.1 2024 年 5 月 13 日
0.15.0 2024 年 5 月 13 日

725解析器实现 中排名

Download history 235/week @ 2024-05-11 18/week @ 2024-05-18 3/week @ 2024-05-25 175/week @ 2024-06-08 12/week @ 2024-06-15 90/week @ 2024-07-20 58/week @ 2024-07-27

每月 148 次下载

MIT 许可证

66KB
984

✨📄 Sparkle Interactions

Twilight 提供安全、简洁的 Discord 交互处理

✨ 特性

响应交互

交互处理提供了一个交互句柄,用于响应交互,它保存了交互的状态。

句柄有一个 respond 方法,用于根据状态决定是创建交互响应还是后续消息。

有关更多信息,请参阅 handle 模块的文档。

跟踪最后响应

可选地,交互句柄可以跟踪最后发送的消息。提供了一些方法来返回或更新最后一条消息。

有关更多信息,请参阅 handle 模块的文档。

提取交互数据

此库提供了提取交互数据、命令选项和模态组件的方法,简洁明了。

有关更多信息,请参阅 extract 模块的文档。

构建器

库提供了组件和交互响应的构建器,允许您简洁且安全地创建这些结构。

有关更多信息,请参阅 builder 模块的文档。

🏷️ 版本控制

由于此软件包是 Twilight 的第三方软件包,其次要版本遵循此软件包支持的 Twilight 的次要版本。

例如,对于支持 Twilight 0.15.4 的软件包版本,此软件包的版本将是 0.15.x,其中 x 可以是任何数字。

🧪 测试

此软件包使用单元测试和集成测试。单元测试可以像往常一样运行,而集成测试需要一些设置。

由于集成测试接收 Discord 事件并向 Discord 发送请求,您应该首先在位于此存储库根目录的 .env 文件中设置以下环境变量

  • BOT_TOKEN: 用于测试的机器人的令牌
  • GUILD_ID: 将创建测试命令的服务器 ID
  • CHANNEL_ID: 将创建带有组件的测试消息的频道 ID

每个测试都在一个交互上运行。由于机器人无法创建交互,在运行测试时,机器人将等待一个用于测试的 InteractionCreate 事件。对于不在组件交互上运行的测试,您应该首先运行测试,然后手动发送 sparkle_interactions_test 命令,之后机器人将在您创建的交互上运行测试。对于在组件交互上运行的测试,机器人在运行测试时将发送带有组件的消息。点击组件后,测试将继续。

🙋 想要:问题

虽然这个库经过了大量测试,但仍可能存在一些错误;或者您可能有很好的想法。请创建问题或PR来报告错误、建议和添加功能。

依赖项

~14MB
~263K SLoC