Merge pull request #1 from mimamch/parseOrThrow

update v1.1.0

dist/command-processor.d.ts

@@ -6,13 +6,24 @@ declare class CommandProcessor<T extends Commands> {
     constructor(events: T);
     /**
      * Parses and executes a command with the given arguments.
+     * @deprecated use parse method instead
      *
      * @template E - The type of command to parse and execute.
      * @param {E} command - The command to parse and execute.
      * @param {...Parameters<T[E]>} args - The arguments to pass to the command handler.
      * @returns {ReturnType<T[E]>} - The result of executing the command.
      */
     parseCommand<E extends keyof T>(command: E, ...args: Parameters<T[E]>): ReturnType<T[E]>;
+    /**
+     * Parses and executes a command with the given arguments.
+     *
+     * @template E - The type of command to parse and execute.
+     * @param {E} command - The command to parse and execute.
+     * @param {...Parameters<T[E]>} args - The arguments to pass to the command handler.
+     * @returns {ReturnType<T[E]>} - The result of executing the command.
+     */
+    parse<E extends keyof T>(command: E, ...args: Parameters<T[E]>): ReturnType<T[E]>;
+    parseOrThrow<E extends keyof T>(command: E, ...args: Parameters<T[E]>): ReturnType<T[E]>;
 }
 export default CommandProcessor;
 export { CommandProcessor, Commands };

dist/command-processor.js

@@ -7,13 +7,33 @@ class CommandProcessor {
     }
     /**
      * Parses and executes a command with the given arguments.
+     * @deprecated use parse method instead
      *
      * @template E - The type of command to parse and execute.
      * @param {E} command - The command to parse and execute.
      * @param {...Parameters<T[E]>} args - The arguments to pass to the command handler.
      * @returns {ReturnType<T[E]>} - The result of executing the command.
      */
     parseCommand(command, ...args) {
+        var _a, _b;
+        return (_b = (_a = this.events)[command]) === null || _b === void 0 ? void 0 : _b.call(_a, args);
+    }
+    /**
+     * Parses and executes a command with the given arguments.
+     *
+     * @template E - The type of command to parse and execute.
+     * @param {E} command - The command to parse and execute.
+     * @param {...Parameters<T[E]>} args - The arguments to pass to the command handler.
+     * @returns {ReturnType<T[E]>} - The result of executing the command.
+     */
+    parse(command, ...args) {
+        var _a, _b;
+        return (_b = (_a = this.events)[command]) === null || _b === void 0 ? void 0 : _b.call(_a, args);
+    }
+    parseOrThrow(command, ...args) {
+        if (!(command in this.events)) {
+            throw new Error(`command ${command.toString()} is not registered`);
+        }
         return this.events[command](args);
     }
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mimamch/cmd",
-  "version": "1.0.6",
+  "version": "1.1.0",
   "description": "A command processor library for handling interactive commands",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

readme.md

@@ -45,7 +45,7 @@ const commands = {
 const commandProcessor = new CommandProcessor(commands);
 
 // Execute the "/sayhello" command with the argument "mimamch"
-const sayHelloResult = commandProcessor.parseCommand("/sayhello", "mimamch");
+const sayHelloResult = commandProcessor.parse("/sayhello", "mimamch");
 console.log(sayHelloResult);
 ```
 

src/command-processor.ts

@@ -10,6 +10,7 @@ class CommandProcessor<T extends Commands> {
 
   /**
    * Parses and executes a command with the given arguments.
+   * @deprecated use parse method instead
    *
    * @template E - The type of command to parse and execute.
    * @param {E} command - The command to parse and execute.
@@ -20,6 +21,31 @@ class CommandProcessor<T extends Commands> {
     command: E,
     ...args: Parameters<T[E]>
   ): ReturnType<T[E]> {
+    return this.events[command]?.(args) as ReturnType<T[E]>;
+  }
+
+  /**
+   * Parses and executes a command with the given arguments.
+   *
+   * @template E - The type of command to parse and execute.
+   * @param {E} command - The command to parse and execute.
+   * @param {...Parameters<T[E]>} args - The arguments to pass to the command handler.
+   * @returns {ReturnType<T[E]>} - The result of executing the command.
+   */
+  parse<E extends keyof T>(
+    command: E,
+    ...args: Parameters<T[E]>
+  ): ReturnType<T[E]> {
+    return this.events[command]?.(args) as ReturnType<T[E]>;
+  }
+
+  parseOrThrow<E extends keyof T>(
+    command: E,
+    ...args: Parameters<T[E]>
+  ): ReturnType<T[E]> {
+    if (!(command in this.events)) {
+      throw new Error(`command ${command.toString()} is not registered`);
+    }
     return this.events[command](args) as ReturnType<T[E]>;
   }
 }