@tanzanite/discord-akairo
    Preparing search index...

    Type Alias CommandHandlerOptions

    CommandHandlerOptions: AkairoHandlerOptions<
        Command,
        CommandHandler,
        CommandHandlerEvents,
    > & {
        aliasReplacement?: RegExp;
        allowMention?: boolean
        | MentionPrefixPredicate;
        argumentDefaults?: DefaultArgumentOptions;
        autoDefer?: boolean;
        autoRegisterSlashCommands?: boolean;
        blockBots?: boolean;
        blockClient?: boolean;
        commandUtil?: boolean;
        commandUtilLifetime?: number;
        commandUtilSweepInterval?: number;
        defaultCooldown?: number;
        execSlash?: boolean;
        fetchMembers?: boolean;
        handleEdits?: boolean;
        ignoreCooldown?: ArrayOrNot<Snowflake> | IgnoreCheckPredicateHandler;
        ignorePermissions?: ArrayOrNot<Snowflake> | IgnoreCheckPredicateHandler;
        prefix?: ArrayOrNot<string> | PrefixSupplier;
        skipBuiltInPostInhibitors?: boolean;
        storeMessages?: boolean;
        typing?: boolean;
    }

    Type declaration

    • OptionalaliasReplacement?: RegExp

      Regular expression to automatically make command aliases. For example, using /-/g would mean that aliases containing - would be valid with and without it. So, the alias command-name is valid as both command-name and commandname.

    • OptionalallowMention?: boolean | MentionPrefixPredicate

      Whether or not to allow mentions to the client user as a prefix.

      true
      
    • OptionalargumentDefaults?: DefaultArgumentOptions

      Default argument options.

      {}
      
    • OptionalautoDefer?: boolean

      Automatically defer messages "BotName is thinking"

      false
      
    • OptionalautoRegisterSlashCommands?: boolean

      Specify whether to register all slash commands when starting the client.

      false
      
    • OptionalblockBots?: boolean

      Whether or not to block bots.

      true
      
    • OptionalblockClient?: boolean

      Whether or not to block self.

      true
      
    • OptionalcommandUtil?: boolean

      Whether or not to assign message.util.

      false
      
    • OptionalcommandUtilLifetime?: number

      Milliseconds a message should exist for before its command util instance is marked for removal. If 0, CommandUtil instances will never be removed and will cause memory to increase indefinitely.

      300_000 // 5 minutes
      
    • OptionalcommandUtilSweepInterval?: number

      Time interval in milliseconds for sweeping command util instances. If 0, CommandUtil instances will never be removed and will cause memory to increase indefinitely.

      300_000 // 5 minutes
      
    • OptionaldefaultCooldown?: number

      Default cooldown for commands.

      0
      
    • OptionalexecSlash?: boolean

      Whether or not to require the use of execSlash for slash commands.

      false
      
    • OptionalfetchMembers?: boolean

      Whether or not members are fetched on each message author from a guild.

      false
      
    • OptionalhandleEdits?: boolean

      Whether or not to handle edited messages using CommandUtil.

      false
      
    • OptionalignoreCooldown?: ArrayOrNot<Snowflake> | IgnoreCheckPredicateHandler

      ID of user(s) to ignore cooldown or a function to ignore. Defaults to the client owner(s).

      client.ownerID
      
    • OptionalignorePermissions?: ArrayOrNot<Snowflake> | IgnoreCheckPredicateHandler

      ID of user(s) to ignore userPermissions checks or a function to ignore.

      []
      
    • Optionalprefix?: ArrayOrNot<string> | PrefixSupplier

      The prefix(es) for command parsing.

      "!"
      
    • OptionalskipBuiltInPostInhibitors?: boolean

      Whether or not to skip built in reasons post type inhibitors so you can make custom ones.

      false
      
    • OptionalstoreMessages?: boolean

      Whether or not to store messages in CommandUtil.

      false
      
    • Optionaltyping?: boolean

      Show "BotName is typing" information message on the text channels when a command is running.

      false