@hyperneutrino/djs-lite 1.7.0 → 1.7.2

package/index.ts

@@ -47,7 +47,7 @@ type WrapperConfig<R extends Record<string, Handleable>> = {
 };
 
 /**
- * This is the type of `config.wrappers` in `loadCommands`. This type is exported so that you can expose the wrappers upstream if you are making a library
+ * This is the type of `config.wrappers` in {@link loadCommands}. This type is exported so that you can expose the wrappers upstream if you are making a library
  * surrounding this library.
  */
 export interface CommandWrappers extends WrapperConfig<{
@@ -58,7 +58,7 @@ export interface CommandWrappers extends WrapperConfig<{
 }> {}
 
 /**
- * This is the type of `config.wrappers` in `loadInteractions`. This type is exported so that you can expose the wrappers upstream if you are making a library
+ * This is the type of `config.wrappers` in {@link loadInteractions}. This type is exported so that you can expose the wrappers upstream if you are making a library
  * surrounding this library.
  */
 export interface InteractionWrappers extends WrapperConfig<{
@@ -72,7 +72,7 @@ export interface InteractionWrappers extends WrapperConfig<{
 }> {}
 
 /**
- * This is a union type of `CommandWrappers` and `InteractionWrappers` so you can expose all of them at once (since there is no overlap in the field names).
+ * This is a union type of {@link CommandWrappers} and {@link InteractionWrappers} so you can expose all of them at once (since there is no overlap in the field names).
  */
 export interface Wrappers extends CommandWrappers, InteractionWrappers {}
 
@@ -315,7 +315,9 @@ async function loadSubcommandsAndGroups(directory: string) {
  * @param directory The relative path (from your execution point) containing your command handlers.
  * @param config Command-related configuration values.
  * @param config.guildId The ID of the guild to which to set the commands.
- * @param config.wrappers A set of wrappers which transform all handler functions for each handler type.
+ * @param config.wrappers A set of wrappers which transform all handler functions for each handler type. This wrapper will be called on each of your configured
+ * handlers of the relevant type and must return another handler (i.e. it is a function that transforms its input parameter, which is itself a handler
+ * function). This is like middleware; use this for things like error handling, logging, etc.
  * @returns `commands`, the loaded command data (an array of objects).
  * @returns `slashCommandHandlers`, the map from each slash command name to its handler.
  * @returns `userCommandHandlers`, the map from each user context menu command name to its handler.
@@ -410,7 +412,9 @@ export async function loadCommands(client: Client<true>, directory: string, conf
  * @param directory The relative path (from your execution point) containing your interaction handlers.
  * @param config Interaction-related configuration values.
  * @param config.argumentSeparator The separator used to split custom IDs. This defaults to `:`.
- * @param config.wrappers A set of wrappers which transform all handler functions for each handler type.
+ * @param config.wrappers A set of wrappers which transform all handler functions for each handler type. This wrapper will be called on each of your configured
+ * handlers of the relevant type and must return another handler (i.e. it is a function that transforms its input parameter, which is itself a handler
+ * function). This is like middleware; use this for things like error handling, logging, etc.
  * @returns `modalHandlers`, the map from each modal submit handler's configuration file path to its handler function.
  * @returns `buttonHandlers`, the map from each button handler's configuration file path to its handler function.
  * @returns `stringSelectMenuHandlers`, the map from each string select menu handler's file path to its handler function.

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@hyperneutrino/djs-lite",
     "private": false,
-    "version": "1.7.0",
+    "version": "1.7.2",
     "module": "index.ts",
     "type": "module",
     "devDependencies": {