npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@mimamch/cmd

v1.2.0

Published

A command processor library for handling interactive commands

Downloads

6

Readme

@mimamch/cmd - Powerful and Lightweight Command Processing Library for Interactive Applications

@mimamch/cmd is a library for processing and handling commands in text-based applications. This library provides an efficient way to manage and execute commands provided by users.

Key Features

  • Command Processing: The library allows you to process commands provided by users easily and efficiently.
  • Command Handling: You can define handlers for each command that will be executed when the command is called.
  • Defined Arguments and Types: The library supports the definition of command arguments and corresponding data types for each command, ensuring clarity and validity of the received arguments.
  • Flexible Execution: You can execute commands by providing arguments that match the command definition, ensuring accurate command execution.
  • Defined Return Messages: Each command can produce a return value according to the specified data type, allowing you to provide appropriate responses to users.

Installation

You can install @mimamch/cmd using npm, the package manager for Node.js. Run the following command:

npm install @mimamch/cmd

Usage

To use @mimamch/cmd, follow these steps:

  1. Define your custom commands and their corresponding handlers.
  2. Create an instance of the CommandProcessor class and pass your commands to it.
  3. Use the parseCommand method to execute commands with the specified arguments.

Here's an example of how to use @mimamch/cmd:

const { CommandProcessor } = require("@mimamch/cmd");

// For JS module import
// import CommandProcessor from "@mimamch/cmd";

// Define custom commands and their handlers
const commands = {
  "/sayhello": function (name) {
    return `Hello ${name} welcome to the club 🥳`;
  },
};

// Create a CommandProcessor instance with the defined commands
const commandProcessor = new CommandProcessor(commands);

// Execute the "/sayhello" command with the argument "mimamch"
const sayHelloResult = commandProcessor.parse("/sayhello", "mimamch");
console.log(sayHelloResult);

For more examples and usage scenarios, you can refer to the examples file in the examples directory.

Documentation

For detailed documentation, including guides and API references, please visit the official documentation.

Contributing

Contributions are welcome! Please follow the guidelines outlined in the CONTRIBUTING.md file.

License

This library is licensed under the MIT License.