Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@sapphire/discord.js-utilities

sapphiredev14.9kMIT7.3.3TypeScript support: included

Discord.js specific utilities for your JavaScript/TypeScript bots

@sapphire/discord.js-utilities, bot, typescript, ts, yarn, discord, sapphire, standalone, discord.js

readme

Sapphire Logo

Sapphire Utilities

Common NodeJS packages for Sapphire Repositories and others.

GitHub

Packages

npm npm npm npm npm npm npm npm npm npm npm npm npm npm npm npm npm npm npm npm npm npm npm

Buy us some doughnuts

Sapphire Community is and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!

We accept donations through Open Collective, Ko-fi, Paypal, Patreon and GitHub Sponsorships. You can use the buttons below to donate through your method of choice.

Donate With Address
Open Collective Click Here
Ko-fi Click Here
Patreon Click Here
PayPal Click Here

Contributors

Please make sure to read the Contributing Guide before making a pull request.

Thank you to all the people who already contributed to Sapphire!

changelog

Changelog

All notable changes to this project will be documented in this file.

@sapphire/discord.js-utilities@7.3.3 - (2025-05-07)

🏠 Refactor

  • discord.js-utilities: Replace ephemeral with message flags (cfb8940) (#876 by @SerenModz21)

🐛 Bug Fixes

  • discord.js-utilities: Update the action row component type (3b2a6fa) (#888 by @SerenModz21)
  • paginatedmessage: Resolve ts-expect-error by omitting flags from WebhookMessageEditOptions (87bbf48)
  • deps: Update all non-major dependencies (bc2f01c) (#869 by @renovate[bot])

@sapphire/discord.js-utilities@7.3.2 - (2025-01-05)

🐛 Bug Fixes

  • discord.js: Update code for latest discord.js and discord-api-types (15bf4d5) (#852 by @favna)

@sapphire/discord.js-utilities@7.3.1 - (2024-11-02)

🏠 Refactor

  • Resolve several sonar issues (ba915f9) (#823 by @favna)

🐛 Bug Fixes

  • Update for latest discord.js (86dab68) (#799 by @favna)

@sapphire/discord.js-utilities@7.3.0 - (2024-06-03)

📝 Documentation

  • discord.js-utilities: Fix tsdoc comments (04bc8e2)
  • discord.js-utilities: Fix tsdoc comment (6f16000)
  • discord.js-utilities: Fix tsdoc comments (ea3f3d6)

🚀 Features

  • discord.js-utilities: Add attachment type guards (4660670)

@sapphire/discord.js-utilities@7.2.1 - (2024-05-06)

🐛 Bug Fixes

  • PaginatedMessage: Fix support for discordjs 14.5.2 (07a0cfa)

@sapphire/discord.js-utilities@7.2.0 - (2024-04-13)

🚀 Features

  • discord.js-utilities: Add components to MessageBuilder (#734) (f463545)

@sapphire/discord.js-utilities@7.1.6 - (2024-01-19)

🐛 Bug Fixes

  • Fixed commonjs typings export mapping (#707) (216ff02)

@sapphire/discord.js-utilities@7.1.5 - (2023-12-27)

🏠 Refactor

  • PaginatedMessage: Always put link buttons below select menus (#699) (86b58d0)

🐛 Bug Fixes

  • PaginatedMessage: Fixed link buttons not properly being added (#698) (aa3e3eb)

📝 Documentation

  • createPartitionedMessageRow: Fix documentation for docusaurus rendering (0c8d013)
  • createPartitionedMessageRow: Fix documentation for docusaurus rendering (ab04d55)

@sapphire/discord.js-utilities@7.1.4 - (2023-12-15)

🐛 Bug Fixes

  • PaginatedMessage: Make it possible to disable adding page numbers to the footer through setShouldAddFooterToEmbeds (dc18281)
  • paginatedmessage: Check for pageActions before throwing an error (#684) (740b317)

📝 Documentation

  • PaginatedMessage: Add AI generated tsdoc to remaining items (4ca1c55)
  • PaginatedMessage: Add AI generated doc comments on all undocumented fields (fdba2bb)

🪞 Styling

  • Run prettier on the codebase (1d6e994)

@sapphire/discord.js-utilities@7.1.3 - (2023-12-04)

🐛 Bug Fixes

  • discord.js-utilities: Properly split CJS and ESM (3f9bd6a)

@sapphire/discord.js-utilities@7.1.2 - (2023-11-16)

🐛 Bug Fixes

  • paginatedmessage: Fixed interacting with multiple users on multiple ephemeral interactions (#666) (0c4ba3c)

📝 Documentation

  • typeguards: Improve the docs for isAnyInteraction and isAnyInteractableInteraction (#667) (f4ec262)

@sapphire/discord.js-utilities@7.1.0 - (2023-11-15)

🚀 Features

  • PaginatedMessage: Improve @discordjs/builders support (#659) (0cbf663)

@sapphire/discord.js-utilities@7.0.3 - (2023-11-14)

🐛 Bug Fixes

  • discord.js-utilities: Fixed isNsfwChannel typeguard by including ChannelType.GuildMedia (#665) (7c6cfe2)

📝 Documentation

  • discord.js-utilities: Update discord.js.org links (#662) (9c92477)

@sapphire/discord.js-utilities@7.0.2 - (2023-08-29)

🐛 Bug Fixes

  • discord.js-utilities: Output proper dist files (75fded2)
  • discord.js-utilities: Revised type-guards for thread channels (#639) (62f14dc)

@sapphire/discord.js-utilities@7.0.1 - (2023-07-21)

🐛 Bug Fixes

  • tsconfig: Set noEmitHelpers to false (#620) (8ed04bf)

🧪 Testing

  • Update vitest to coverage v8 (a4bc6e4)

@sapphire/discord.js-utilities@7.0.0 - (2023-05-28)

🏠 Refactor

  • PaginatedMessage: Cleaned up some internal type casting. (870252d)
  • PaginatedMessage: The callback union is removed from messages property. pages are always processed with resolvePage meaning they can never be a callback. (4407907)
  • PaginatedMessage: PaginatedMessageMessageOptionsUnion now omits components as it was not handled anyway. (d60b8e2)
  • PaginatedMessage: Allow PaginatedMessage actions run to be optional and instead get handled by Sapphire interaction-handlers (d87eede)
    • 💥 BREAKING CHANGE: updateCurrentPage components are now resolved from the actions property instead of the components property. This makes it consistent with all the other page manipulation methods
    • 💥 BREAKING CHANGE: Removed getComponents since it is effectively useless due to the above change.

🚀 Features

  • PaginatedMessage: Added utility functions for type-guarding action variants. (5c0ae46)

@sapphire/discord.js-utilities@6.1.0 - (2023-05-05)

🚀 Features

  • PaginatedMessage: Add support for all select menus (#589) (4858486)
  • PaginatedMessage: Add support for per-page actions (#587) (b917236)
  • PaginatedMessage: Add method to update pages after response (#584) (db13068)

@sapphire/discord.js-utilities@6.0.7 - (2023-05-02)

🐛 Bug Fixes

  • PaginatedMessage: Only add options and placeholder to the built-in StringSelectMenu (#575) (49d588b)
  • paginatedmessage: Fix checks for actionIsButtonOrMenu (3f5d500)

📝 Documentation

  • paginatedmessage: Fix examples (c080740)

@sapphire/discord.js-utilities@6.0.6 - (2023-04-17)

🐛 Bug Fixes

  • discord.js-utilities: Add tslib dependency to fix __exportStar not being defined (2f6e4e6)

@sapphire/discord.js-utilities@6.0.5 - (2023-04-10)

🐛 Bug Fixes

  • discord.js-utilities: Add missing type modifiers (b372e79)
  • deps: Update all non-major dependencies (#577) (291dd67)

@sapphire/discord.js-utilities@6.0.4 - (2023-03-14)

🐛 Bug Fixes

  • discord.js-utilities: Fixed deprecated code (#565) (e6c8000)

@sapphire/discord.js-utilities@6.0.3 - (2023-03-09)

🐛 Bug Fixes

  • discord.js-utilities: Fixed isAnyInteraction types (#559) (334c16c)

@sapphire/discord.js-utilities@6.0.2 - (2023-02-18)

🐛 Bug Fixes

  • discord.js-utilities: Type fix for discord-api-types 0.37.35 (73d073a)
  • discord.js-utilities: Type fix for discord-api-types 0.37.35 (153dad4)
  • deps: Update all non-major dependencies (#545) (40ca040)
  • discord.js-utilities: Fixed deprecated code (b5d55e9)

@sapphire/discord.js-utilities@6.0.1 - (2023-01-13)

🐛 Bug Fixes

  • discord.js-utilities: Fixed deprecated code (b5d55e9)

@sapphire/discord.js-utilities@6.0.0 - (2023-01-08)

📝 Documentation

  • Add @06000208 as a contributor (fa3349e)

🚀 Features

  • deps: Support for djs v14 (#434) (2e2c3e9)

@sapphire/discord.js-utilities@5.1.2 - (2022-11-19)

🐛 Bug Fixes

  • discord.js-utilities: Added null checks for permission checks (#523) (1abc270)
  • deps: Update all non-major dependencies (#514) (21b07d5)
  • deps: Update all non-major dependencies (#505) (6178296)

📝 Documentation

  • Add @didinele as a contributor (42ef7b6)
  • Add @goestav as a contributor (0e56a92)
  • Add @CitTheDev as a contributor (34169ea)
  • Add @legendhimslef as a contributor (059b6f1)

@sapphire/discord.js-utilities@5.1.1 - (2022-10-09)

🐛 Bug Fixes

  • discord.js-utilities: Fixed stop button crashing bots (d5a9fc6)

@sapphire/discord.js-utilities@5.1.0 - (2022-10-08)

🐛 Bug Fixes

  • utilities: Race condition issue for closed paginated message (#484) (8c9c9b7)
  • deps: Update all non-major dependencies (#466) (dc08606)

📝 Documentation

  • Add @r-priyam as a contributor (fb278ba)

🚀 Features

  • utilities: Add possibility to import single functions by appending them to the import path. (#454) (374c145)

@sapphire/discord.js-utilities@5.0.1 - (2022-09-18)

🏠 Refactor

  • Split @sapphire/time-utilities into 4 sub-packages (#462) (574299a)

🐛 Bug Fixes

  • deps: Update all non-major dependencies (e20f299)

📝 Documentation

  • Change name of @kyranet (#451) (df4fdef)
  • Update @RealShadowNova as a contributor (a869ba0)

@sapphire/discord.js-utilities@5.0.0 - (2022-08-14)

🏠 Refactor

  • djs-utilities: Remove deprecated code (#426) (e6d20aa)
    • 💥 BREAKING CHANGE: removed deprecated author field on PaginatedMessage
    • 💥 BREAKING CHANGE: removed deprecated function runsOnInteraction

🐛 Bug Fixes

  • deps: Update all non-major dependencies (2308bd7)

@sapphire/discord.js-utilities@4.12.0 - (2022-08-13)

🐛 Bug Fixes

  • deps: Update all non-major dependencies (84af0db)

📝 Documentation

  • Add @muchnameless as a contributor (a1221fe)
  • Add @enxg as a contributor (d2382f0)
  • Add @EvolutionX-10 as a contributor (efc3a32)

🚀 Features

  • discord.js-utilities: Rename runsOnInteraction to isAnyInteraction and add deprecation notice for the former (b2486c2)
  • discord.js-utilities: Add ChatInputOrContextMenuInteraction, NonModalInteraction, and AnyInteraction utility types (703259a)

🧪 Testing

  • Migrate to vitest (#380) (075ec73)

@sapphire/discord.js-utilities@4.11.3 - (2022-06-13)

🐛 Bug Fixes

  • deps: Update all non-major dependencies (#378) (9a20de6)

@sapphire/discord.js-utilities@4.11.1 - (2022-06-02)

🐛 Bug Fixes

  • paginated-message: Fixed an issue cancelling a paginated message after an ephemeral reply (#372) (5d545a5)
  • discord.js-utilities: Add APIInteractionDataResolvedGuildMember type to isGuildMember function (#363) (522c305)

📝 Documentation

  • Add @MajesticString as a contributor (295b3e9)
  • Add @Mzato0001 as a contributor (c790ef2)

@sapphire/discord.js-utilities@4.11.0 - (2022-05-15)

🐛 Bug Fixes

  • PaginatedMessage: Broaden option types (#350) (a747050)

🚀 Features

  • discord.js-utilities: Update to DJS v13.7 (76e4efd)
  • discord.js-utilities: IsGuildMember type guard (#349) (c3a77c0)

@sapphire/discord.js-utilities@4.10.0 - (2022-05-01)

🚀 Features

  • PaginatedMessage: Supports placeholder setting for default SelectMenu (#342) (101ea97)

@sapphire/discord.js-utilities@4.12.0 - (2022-08-13)

🐛 Bug Fixes

  • deps: Update all non-major dependencies (84af0db)

📝 Documentation

  • Add @muchnameless as a contributor (a1221fe)
  • Add @enxg as a contributor (d2382f0)
  • Add @EvolutionX-10 as a contributor (efc3a32)

🚀 Features

  • discord.js-utilities: Rename runsOnInteraction to isAnyInteraction and add deprecation notice for the former (b2486c2)
  • discord.js-utilities: Add ChatInputOrContextMenuInteraction, NonModalInteraction, and AnyInteraction utility types (703259a)

🧪 Testing

  • Migrate to vitest (#380) (075ec73)

@sapphire/discord.js-utilities@4.11.3 - (2022-06-13)

🐛 Bug Fixes

  • deps: Update all non-major dependencies (#378) (9a20de6)

@sapphire/discord.js-utilities@4.11.1 - (2022-06-02)

🐛 Bug Fixes

  • paginated-message: Fixed an issue cancelling a paginated message after an ephemeral reply (#372) (5d545a5)
  • discord.js-utilities: Add APIInteractionDataResolvedGuildMember type to isGuildMember function (#363) (522c305)

📝 Documentation

  • Add @MajesticString as a contributor (295b3e9)
  • Add @Mzato0001 as a contributor (c790ef2)

@sapphire/discord.js-utilities@4.11.0 - (2022-05-15)

🐛 Bug Fixes

  • PaginatedMessage: Broaden option types (#350) (a747050)

🚀 Features

  • discord.js-utilities: Update to DJS v13.7 (76e4efd)
  • discord.js-utilities: IsGuildMember type guard (#349) (c3a77c0)

@sapphire/discord.js-utilities@4.10.0 - (2022-05-01)

🚀 Features

  • PaginatedMessage: Supports placeholder setting for default SelectMenu (#342) (101ea97)

@sapphire/discord.js-utilities@4.11.3 - (2022-06-13)

🐛 Bug Fixes

  • deps: Update all non-major dependencies (#378) (9a20de6)

@sapphire/discord.js-utilities@4.11.1 - (2022-06-02)

🐛 Bug Fixes

  • paginated-message: Fixed an issue cancelling a paginated message after an ephemeral reply (#372) (5d545a5)
  • discord.js-utilities: Add APIInteractionDataResolvedGuildMember type to isGuildMember function (#363) (522c305)

📝 Documentation

  • Add @MajesticString as a contributor (295b3e9)
  • Add @Mzato0001 as a contributor (c790ef2)

@sapphire/discord.js-utilities@4.11.0 - (2022-05-15)

🐛 Bug Fixes

  • PaginatedMessage: Broaden option types (#350) (a747050)

🚀 Features

  • discord.js-utilities: Update to DJS v13.7 (76e4efd)
  • discord.js-utilities: IsGuildMember type guard (#349) (c3a77c0)

@sapphire/discord.js-utilities@4.10.0 - (2022-05-01)

🚀 Features

  • PaginatedMessage: Supports placeholder setting for default SelectMenu (#342) (101ea97)

@sapphire/discord.js-utilities@4.11.1 - (2022-06-02)

🐛 Bug Fixes

  • paginated-message: Fixed an issue cancelling a paginated message after an ephemeral reply (#372) (5d545a5)
  • discord.js-utilities: Add APIInteractionDataResolvedGuildMember type to isGuildMember function (#363) (522c305)

📝 Documentation

  • Add @MajesticString as a contributor (295b3e9)
  • Add @Mzato0001 as a contributor (c790ef2)

@sapphire/discord.js-utilities@4.11.0 - (2022-05-15)

🐛 Bug Fixes

  • PaginatedMessage: Broaden option types (#350) (a747050)

🚀 Features

  • discord.js-utilities: Update to DJS v13.7 (76e4efd)
  • discord.js-utilities: IsGuildMember type guard (#349) (c3a77c0)

@sapphire/discord.js-utilities@4.10.0 - (2022-05-01)

🚀 Features

  • PaginatedMessage: Supports placeholder setting for default SelectMenu (#342) (101ea97)

@sapphire/discord.js-utilities@4.11.1 - (2022-06-02)

🐛 Bug Fixes

  • paginated-message: Fixed an issue cancelling a paginated message after an ephemeral reply (#372) (5d545a5)
  • discord.js-utilities: Add APIInteractionDataResolvedGuildMember type to isGuildMember function (#363) (522c305)

📝 Documentation

  • Add @MajesticString as a contributor (295b3e9)
  • Add @Mzato0001 as a contributor (c790ef2)

@sapphire/discord.js-utilities@4.11.0 - (2022-05-15)

🐛 Bug Fixes

  • PaginatedMessage: Broaden option types (#350) (a747050)

🚀 Features

  • discord.js-utilities: Update to DJS v13.7 (76e4efd)
  • discord.js-utilities: IsGuildMember type guard (#349) (c3a77c0)

@sapphire/discord.js-utilities@4.10.0 - (2022-05-01)

🚀 Features

  • PaginatedMessage: Supports placeholder setting for default SelectMenu (#342) (101ea97)

@sapphire/discord.js-utilities@4.11.0 - (2022-05-15)

🐛 Bug Fixes

  • PaginatedMessage: Broaden option types (#350) (a747050)

🚀 Features

  • discord.js-utilities: Update to DJS v13.7 (76e4efd)
  • discord.js-utilities: IsGuildMember type guard (#349) (c3a77c0)

@sapphire/discord.js-utilities@4.10.0 - (2022-05-01)

🚀 Features

  • PaginatedMessage: Supports placeholder setting for default SelectMenu (#342) (101ea97)

@sapphire/discord.js-utilities@4.10.0 - (2022-05-01)

Features

  • PaginatedMessage: Supports placeholder setting for default SelectMenu (#342) (101ea97)

@sapphire/discord.js-utilities@4.9.7 - (2022-04-24)

Bug Fixes

  • PaginatedMessage: Make resolvePaginatedMessageInternationalizationContext protected (0bb7c55)

@sapphire/discord.js-utilities@4.9.6 - (2022-04-24)

Bug Fixes

  • PaginatedMessage: Update i18nContext to match plugin-i18next (#337) (bcc053c)

Documentation

  • discord.js-utilities: Fix typo (#332) (0c4b486)

@sapphire/discord.js-utilities@4.9.5 - (2022-04-21)

Bug Fixes

  • PaginatedMessages: Missing logic cases (#331) (e2c4d87)

Documentation

  • Add @NotKaskus as a contributor (00da8f1)
  • Add @imranbarbhuiya as a contributor (fb674c2)
  • Add @axisiscool as a contributor (ce1aa31)
  • Add @dhruv-kaushikk as a contributor (ebbf43f)
  • Add @Commandtechno as a contributor (f1d69fa)
  • Fix typedoc causing OOM crashes (63ba41c)
  • Add deprecation notice to isStoreChannel() (#323) (2f790dc)

4.9.4 (2022-04-01)

Bug Fixes

  • PaginatedMessage: removed duplicate page index footers on multiple embed pages (#320) (0d6934d)

4.9.3 (2022-03-20)

Note: Version bump only for package @sapphire/discord.js-utilities

4.9.2 (2022-03-20)

Note: Version bump only for package @sapphire/discord.js-utilities

4.9.1 (2022-03-11)

Note: Version bump only for package @sapphire/discord.js-utilities

4.9.0 (2022-03-06)

Features

4.8.2 (2022-03-01)

Note: Version bump only for package @sapphire/discord.js-utilities

4.8.1 (2022-02-18)

Bug Fixes

  • PaginatedMessage: allow overwriting SelectMenu options (#298) (10f3c25), closes #297

4.8.0 (2022-02-15)

Bug Fixes

  • MessagePrompter: fixed example code in tsdoc (2d2f9f9), closes #285

Features

  • PaginatedMessage: emit warning when running in a DM channel without required client options (#291) (668c540)

4.7.0 (2022-02-11)

Features

  • PaginatedMessage: support context menu interactions (#290) (b2120d4)

4.6.2 (2022-02-07)

Bug Fixes

  • PaginatedMessage: fixes for modifying the components when the bot doesn't have VIEW_CHANNEL (#289) (c808a0a)

4.6.1 (2022-02-06)

Bug Fixes

  • PaginatedMessage: fix footer application when there are multiple embeds (#288) (8806e8a)

4.6.0 (2022-02-03)

Bug Fixes

  • discord.js-utilities: fixed PaginatedMessage not filtering to the correct response and user (7a15a2f)
  • fixed issues with PaginatedMessage (#283) (9656d2a)
  • PaginatedMessage: adjust default wrongUserInteractionReply to account for the SelectMenu (0888509)
  • PaginatedMessage: update error message thrown when no actions are found in run (#277) (deb9bd3)

Features

  • add canJoinVoiceChannel, isVoiceBasedChannel (#284) (69b9eae)
  • discord.js-utilities: add isMessageInstance typeguard for APIMessage vs Message (c3787f3)
  • ts-config: add multi-config structure (#281) (b5191d7)

4.5.0 (2022-01-28)

Bug Fixes

  • PaginatedMessageEmbedFields: custom template with fields (#276) (edfbf1c)

Features

4.4.0 (2022-01-21)

Features

  • PaginatedMessage: add support for interactions (#264) (d55b17e)

4.3.1 (2022-01-21)

Bug Fixes

  • discord.js-utilities: fixed the export of PaginatedMessageEmbedFields (ba1edd9)

4.3.0 (2022-01-16)

Bug Fixes

  • PaginatedMessageEmbedFields: export class at top level (#260) (e04f762)

Features

  • PaginatedMessage: made it possible to add custom link buttons with setActions / addActions / addAction (#259) (e8d7048)

4.2.0 (2022-01-12)

Features

  • discord.js-utilities: add PaginatedMessageEmbedFields (#254) (bf3a89a), closes #256

4.1.6 (2022-01-10)

Note: Version bump only for package @sapphire/discord.js-utilities

4.1.5 (2021-12-08)

Note: Version bump only for package @sapphire/discord.js-utilities

4.1.4 (2021-11-29)

Note: Version bump only for package @sapphire/discord.js-utilities

4.1.3 (2021-11-19)

Bug Fixes

  • PaginatedMessage: partition buttons and select menus (#221) (47c37e7)

4.1.2 (2021-11-15)

Note: Version bump only for package @sapphire/discord.js-utilities

4.1.1 (2021-11-06)

Note: Version bump only for package @sapphire/discord.js-utilities

4.1.0 (2021-10-31)

Bug Fixes

  • PaginatedMessage: allow internationalizationContext to be async (e1251fc)
  • PaginatedMesssage: change private to protected properties (495aef8)

Features

  • PaginatedMessage: add internationalization context to selectMenuOptions and wrongUserInteractionReply (190a8fe)

4.0.2 (2021-10-29)

Bug Fixes

  • PaginatedMessage: fixed multiple page embeds not working (52f2cbb)

4.0.1 (2021-10-28)

Bug Fixes

  • discord.js-utilities: build with tsc instead of rollup (59a3d03)
  • PaginatedMessage: ensure async function pages are resolved properly (500b67b)
  • PaginatedMessage: ensure components aren't added when there's 1 page or less (9973b8e)
  • PaginatedMessage: fixed template not applying (1d9c7cc)
  • PaginatedMessage: properly resolve and apply template (5d784bf)

4.0.0 (2021-10-26)

Features

  • PaginatedMessage: migrate from emoji reactions to MessageButtons (#203) (aeb3ee6)

BREAKING CHANGES

  • PaginatedMessage: PaginatedMessage no longer uses emoji reactions. This means the bot no longer needs MANAGE_MESSAGES to change pages. You can now fully use PaginatedMessage in DMs!
  • PaginatedMessage: It is no longer possible to add more than 25 pages to a PaginatedMessage without modifying the action as we now use a SelectMenu for custom page picking as opposed to prompt and chat input, and Discord limits the amount of options in a SelectMenu to 25. Upon hitting 25 pages any others won't be added, and a warning will be emitted to inform you of this issue.
  • PaginatedMessage: A bunch of TypeScript types for PaginatedMessage changed in name, if you were previously explicitly setting any types you will have to update those. All types for PaginatedMessage now follow the naming pattern of PaginatedMessage....
  • PaginatedMessage: PaginatedMessage.promptMessage has been removed as the prompt message has been replaced with a SelectMenu. You can customize the entries for the SelectMenu with PaginatedMessage.setSelectMenuOptions.
  • PaginatedMessage: When adding pages to a PaginatedMessage through the pages constructor option, that now takes an object of MessageOptions | WebhookEditMessageOptions.
  • PaginatedMessage: The structure for custom actions through PaginatedMessage#defaultActions or in the constructor of a new PaginatedMessage has changed to incorporate MessageButtons. Please check the updated documentation to see how to update your actions.
  • PaginatedMessage: PaginatedMessage option paginatedMessageData now takes an object of type MessageOptions | WebhookEditMessageOptions.
  • PaginatedMessage: Whenever someone clicks a button of a PaginatedMessage that's not for them they will be send an ephemeral message to inform them of this. You can disable this by overwriting PaginatedMessage#handleCollect. Furthermore, if you just want a different message, you can set it with the static property PaginatedMessage.wrongUserMessage.

3.2.2 (2021-10-17)

Bug Fixes

  • allow more node & npm versions in engines field (5977d2a)

3.2.1 (2021-10-11)

Note: Version bump only for package @sapphire/discord.js-utilities

3.2.0 (2021-10-10)

Features

3.1.0 (2021-10-08)

Features

  • discord.js-utilities: add support for setting custom page options (#196) (9baa7c0)

3.0.2 (2021-10-08)

Note: Version bump only for package @sapphire/discord.js-utilities

3.0.1 (2021-10-04)

Note: Version bump only for package @sapphire/discord.js-utilities

3.0.0 (2021-10-04)

Bug Fixes

  • discord.js-utilities: account thread channels in permission checks (#165) (d4982ed)
  • discord.js-utilities: allow more channel types for MessagePrompter (cf7c8ed)
  • discord.js-utilities: allow more types in can* methods (15fcf51)
  • discord.js-utilities: fixed examples for MessagePrompter (660f4be)
  • discord.js-utilities: import type from dapi types v9 (9b57a29)
  • discord.js-utilities: mismatch between types (#161) (823c6b1)
  • discord.js-utilities: remove MessagePrompterStrategies in favour of keyof StrategyReturns (#159) (c185369)
  • djs-utilities: fixed parameter types for type guards (#152) (6e8314f)
  • PaginatedMessage: fixed embedFooterSeperator -> embedFooterSeparator (#191) (cf2c08f)
  • PaginatedMessage: fixed formatting for embed footers (a4e5a56)
  • utilities: rename Awaited<T> to Awaitable<T> (#193) (6ff3e28)

Features

  • backported more utilities and fixed bugs (5cb1862)
  • decorators: add RequiresUserPermissions (688e39f)
  • discord.js-utilities: add isTextBasedChannel channel type guard (ec70645)
  • discord.js-utilities: add pageIndexPrefix static property (#143) (3c95c6f)
  • discord.js-utilities: add PaginatedFieldMessageEmbed (#144) (2c2df24)
  • discord.js-utilities: add many more utilities (#147) (ba5c590)
  • discord.js-utilities: add more thread-related type guards (#155) (e5418d0)
  • discord.js-utilities: add more typeguards + update checks (#162) (b89de42)
  • discord.js-utilities: option to make Prompters edit a message (#160) (31af761)
  • discord.js-utilities: set minimum NodeJS to v16.6.0 (2abc6c1)
  • discord.js-utilities: update for Discord.JS v13 (#135) (f5a8f64)
  • PaginatedMessage: made separator text of embed field customizable (#188) (82f4dab)

BREAKING CHANGES

  • utilities: Awaited has been renamed to Awaitable
  • PaginatedMessage: embedFooterSeperator -> embedFooterSeparator
  • discord.js-utilities: MessagePrompterStrategies does no exist as it was not mutable with type augmentation
  • discord.js-utilities: If you had custom strategies then be sure to instead module augment StrategyReturns with your added keys.
  • Increased strictness of isCategoryChannel
  • Increased strictness of isStageChannel
  • Increased strictness of isStoreChannel
  • Increased strictness of isThreadChannel
  • Increased strictness of isVoiceChannel
  • Lowered strictness of isDMChannel
  • Lowered strictness of isGuildBasedChannel
  • Lowered strictness of isGuildBasedChannelByGuildKey
  • Lowered strictness of isNewsChannel
  • Lowered strictness of isTextChannel
  • decorators: RequiresPermissions has been renamed to RequiresClientPermissions
  • decorators: enum entry DecoratorIdentifiers.RequiresPermissionsGuildOnly has been changed to DecoratorIdentifiers.RequiresClientPermissionsGuildOnly
  • decorators: enum entry DecoratorIdentifiers.RequiresPermissionsMissingPermissions has been changed to DecoratorIdentifiers.RequiresClientPermissionsMissingPermissions
  • decorators: i18n identifier requiresPermissionsGuildOnly has been changed to requiresClientPermissionsGuildOnly
  • decorators: i18n identifier requiresPermissionsMissingPermissions has been changed to requiresClientPermissionsMissingPermissions
  • discord.js-utilities: As this release bumps the minimum Discord.JS version from v12.x to v13.x we also advice looking at The DiscordJS v12 to v13 migration guide
  • discord.js-utilities: Awaited utility type is no longer exported from constants. Use @sapphire/utilities.
  • discord.js-utilities: Constructor utility type is no longer exported from constants. Use @sapphire/utilities.
  • discord.js-utilities: MessageBuilder.allowedMentions's type has been changed to MessageOptions['allowedMentions']
  • discord.js-utilities: MessageBuilder.code has been removed as this is no longer in the MessageOptions of Discord.JS
  • discord.js-utilities: MessageBuilder.content's type has been changed to MessageOptions['content']
  • discord.js-utilities: MessageBuilder.embed has been changed to MessageBuilder.embeds
  • discord.js-utilities: MessageBuilder.embeds's type has been changed to MessageOptions['embeds']
  • discord.js-utilities: MessageBuilder.files's type has been changed to MessageOptions['files']
  • discord.js-utilities: MessageBuilder.nonce's type has been changed to MessageOptions['nonce']
  • discord.js-utilities: MessageBuilder.setEmbed() has been changed to MessageBuilder.setEmbeds()
  • discord.js-utilities: MessageBuilder.split has been removed as this is no longer in the MessageOptions of Discord.JS
  • discord.js-utilities: MessageBuilder.tts's type has been changed to MessageOptions['tts']
  • discord.js-utilities: MessagePrompterMessage has been changed from APIMessageContentResolvable | (MessageOptions & { split?: false }) | MessageAdditions to ArgumentTypes<PartialTextBasedChannelFields['send']>[0], which is the same type as the single argument for the common message.channel.send() method.
  • discord.js-utilities: When providing more than 1 embed template to PaginatedMessages.options.template as well as more than 1 embed on a given MessagePage an attempt will be made to apply to footer of the template at the respective index, otherwise it will fallback to the footer of the first embed in the template, and if that fails it will be an empty string.

2.0.2 (2021-07-20)

Note: Version bump only for package @sapphire/discord.js-utilities

2.0.1 (2021-07-18)

Bug Fixes

  • discord.js-utilities: fix run method for PaginatedMessage (#137) (76b50e0)

2.0.0 (2021-07-17)

Features

  • discord.js-utilities: improve PaginatedMessage (#134) (ad62513)

BREAKING CHANGES

  • discord.js-utilities: PaginatedMessageOptions.run now takes a single parameter of Message instead of 2 parameters (User and TextChannel | NewsChannel)
  • discord.js-utilities: Reactions will no longer be added if your PaginatedMessage only has 1 page
  • discord.js-utilities: TypeScript types for various methods that previously had TextChannel | NewsChannel have been changed to Message['channel']
  • discord.js-utilities: 1 user can no longer have more than 1 PaginatedMessage running. The older one will automatically be cancelled. You can override this by overriding the run method.

1.6.0 (2021-06-27)

Bug Fixes

  • discord.js-utilities: fixed PaginatedMessage#handleEnd (0c05a6b)

Features

  • djs-utilities: verify channel type before removing reaction & allow page prompt customization (e4f49b3), closes #128

1.5.10 (2021-06-19)

Bug Fixes

  • doc: change [@link](https://github.com/link) to [@linkplain](https://github.com/linkplain) for support in VSCode IntelliSense (703d460)
  • docs: update-tsdoc-for-vscode-may-2021 (#126) (f8581bf)

1.5.9 (2021-06-06)

Bug Fixes

  • remove peer deps, update dev deps, update READMEs (#124) (67256ed)

1.5.8 (2021-05-20)

Bug Fixes

  • discord.js-utilities: mark package as side effect free (9fdf1d0)

1.5.7 (2021-05-02)

Bug Fixes

  • drop the www. from the SapphireJS URL (494d89f)
  • update all the SapphireJS URLs from .com to .dev (f59b46d)

1.5.6 (2021-04-21)

Note: Version bump only for package @sapphire/discord.js-utilities

1.5.5 (2021-04-19)

Bug Fixes

  • change all Sapphire URLs from "project"->"community" & use our domain where applicable 👨‍🌾🚜 (#102) (835b408)

1.5.4 (2021-04-03)

Bug Fixes

  • discord.js-utilities: message prompter confirm strategy (#96) (c21e428)

1.5.3 (2021-04-03)

Bug Fixes

  • discord.js-utilities: improve MessagePrompter typings (#94) (f828e77)

1.5.2 (2021-03-16)

Bug Fixes

1.5.1 (2021-03-02)

Bug Fixes

  • discord.js-utilities: fixed IMessagePrompterStrategyOptions not being optional (1876355)

1.5.0 (2021-02-22)

Features

  • discord.js-utilities: add MessagePrompter (#59) (d120d95)

1.4.4 (2021-02-18)

Note: Version bump only for package @sapphire/discord.js-utilities

1.4.3 (2021-02-16)

Note: Version bump only for package @sapphire/discord.js-utilities

1.4.2 (2021-02-13)

Features

  • discord-utilities: add discord webhook regex (#70) (8d56522)

1.4.1 (2021-02-13)

Note: Version bump only for package @sapphire/discord.js-utilities

1.4.0 (2021-02-02)

Features

  • discord.js-utilities/pm: minor changes to static defaultActions (#67) (9451815)

1.3.1 (2021-01-21)

Bug Fixes

  • pm,lpm: resolved a couple of bugs, make PM more extensible (#63) (6dc004e)

1.3.0 (2021-01-20)

Features

  • added MessageOptions, make PM and LPM work stateless (#62) (733eab8)

1.2.0 (2021-01-16)

Features

  • paginated-message: expose response, collector, handleEnd and handleCollect (#60) (43cc490)

1.1.0 (2021-01-13)

Features

  • discord.js-utilities: add checking index changes and documentation (#57) (8d99797)

1.0.1 (2021-01-08)

Bug Fixes

  • djs: modifying pages and messages outside of constructor (#55) (6e22cae)

1.0.0 (2021-01-01)

Bug Fixes

  • discord.js-utilities: fix readme stuff more (242fdb8)
  • discord.js-utilities: typo in readme (c7cff05)
  • typo in PaginatedMessage (#53) (d4fb9fa)

Features

  • discord-utilities: add breaking change note to README (cd0b999)
  • add discord.js-utilities pkg (#52) (b61b05c)

BREAKING CHANGES

  • discord-utilities: discord-utilities no longer has type-guard functions as they are now moved to the discord.js-utilities package. Install @sapphire/discord.js-utilities along with @sapphire/discord-utilities to have the full utilities experience.