{"_id":"tmijs-commander","_rev":"50-227877cd1f60278b6f7e63a9c35d425e","name":"tmijs-commander","dist-tags":{"latest":"2.2.3"},"versions":{"2.2.2":{"name":"tmijs-commander","version":"2.2.2","description":"A simple library to easily implement commands into a TMIJS client.","author":{"name":"Zyrakia","email":"mailzyrakia@gmail.com","url":"https://zyrakia.github.io/"},"main":"lib/index","types":"lib/index.d.ts","license":"MIT","scripts":{"prepare":"del /S /Q \"./lib/\" && tsc"},"repository":{"type":"git","url":"git+https://github.com/Zyrakia/TMIJS-Command-Manager.git"},"keywords":["tmi","tmijs","tmi.js","twitch","twitch.tv","manager","commander"],"bugs":{"url":"https://github.com/Zyrakia/TMIJS-Command-Manager/issues"},"homepage":"https://github.com/Zyrakia/TMIJS-Command-Manager#readme","dependencies":{"@types/tmi.js":"^1.4.0"},"devDependencies":{"typescript":"^3.9.7"},"peerDependencies":{"tmi.js":"*"},"gitHead":"b920f81bc2c0cc4a14e3623e7132f9f1e6db3a16","_id":"tmijs-commander@2.2.2","_nodeVersion":"12.16.3","_npmVersion":"6.14.4","dist":{"integrity":"sha512-wQpNwQe2rKlBVjE9viUnVELYr/1KN1hL20IbBR0VADH1GSBPs9T1qP7dGMeb4mWL///Z7uGCipF9lcc9O0soTg==","shasum":"a7f8be16a24c8011198f703f1b6267ea2222e677","tarball":"https://registry.npmjs.org/tmijs-commander/-/tmijs-commander-2.2.2.tgz","fileCount":17,"unpackedSize":15910,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfGn2zCRA9TVsSAnZWagAADS4P/jXa1ilN3SQ1UX4yGfhc\nG1OXe0uxjnu8fl2I516erBfNLQmi6uVmc7ihlkGhsEz56MGCVu9bHQ+yztYm\nYTPVspz66OvsFrr8oiDLA29TYdnZEH47iahdXxfRf830i89LOVE1v4K26IY5\n9wNcttDPr6hYyD1gvcM22QtZ9G4KyZOnwQLhs1rFC+BeDkIQXRWHEuRK6gdT\nf2YGBUu0DELR04gUCM2VpPkakJ1SfFu4Gbdtuj8qejq+DxyIhjSYrU69KOB2\n1gG6VI8eTJ1VFUbsU3Y/VqS/TbV7D85wnzy+ZznlnhC0ptoStQHWWX2N62Ao\neNrA4lh0Ic47sx/+3Ghgqz8POgZ//qMoNA4OWLad/RhLveg0KqcfkCsXWRGw\nIuGp9QpmVrxxuDGNbSezukhLbfmpTMyb9G+92WTsdSR04R1v0k7Q3DrbQXnp\ne0nWbBRHZOxmH3y7bGdqdOfZ6alHvj/g4Ja1YV+gUC7OD1IzyMQ13J+TTp5m\nC9U4O76Xdbgc579NP4WZC/c2MJ9uqT1CHC437dV0tzQewGb16v12QeVHTZ1Q\nqlRr2djfTriczUghceBFqtGr47GyW8MYIo+AR8i0thglZrLQALqpcBN+zOCR\nCdFlAxDN1DYlPqTafQ2XtQDm2QwlPjE4Qbd+y6SjfrygxQgohS7UE1JYt4wn\nb5ZL\r\n=1PAy\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBr4UpOwh+tBhcRx8pv3dAtdXIrEw8h8w4WVixJCnq5RAiBBL335Gdwf/lAma88/S2mLbUzh+1hiKxKSL5/QHbH5AA=="}]},"maintainers":[{"name":"zyrakia","email":"ole.lammers@mail.com"}],"_npmUser":{"name":"zyrakia","email":"ole.lammers@mail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/tmijs-commander_2.2.2_1595571635033_0.7259381509379843"},"_hasShrinkwrap":false},"2.2.3":{"name":"tmijs-commander","version":"2.2.3","description":"A simple library to easily implement commands into a TMIJS client.","author":{"name":"Zyrakia","email":"mailzyrakia@gmail.com","url":"https://zyrakia.github.io/"},"main":"lib/index","types":"lib/index.d.ts","license":"MIT","scripts":{"prepare":"typedoc && type nul > ./docs/.nojekyll && del /S /Q \"./lib/\" && tsc"},"repository":{"type":"git","url":"git+https://github.com/Zyrakia/TMIJS-Command-Manager.git"},"keywords":["tmi","tmijs","tmi.js","twitch","twitch.tv","manager","commander"],"bugs":{"url":"https://github.com/Zyrakia/TMIJS-Command-Manager/issues"},"homepage":"https://github.com/Zyrakia/TMIJS-Command-Manager#readme","dependencies":{"@types/tmi.js":"^1.4.0"},"devDependencies":{"typescript":"^3.9.7"},"peerDependencies":{"tmi.js":"*"},"gitHead":"8b06a5115ad8df3bad87811978538a0c7a17d3da","_id":"tmijs-commander@2.2.3","_nodeVersion":"12.16.3","_npmVersion":"6.14.4","dist":{"integrity":"sha512-bDvOUDWb/z+xvldDvKCI5RZ3Lp4Lv7KczRyHRtIeul3QBZiA7uLdqKVzaP0wDspVEs4wnT2rye0Q3W8VrL4fRA==","shasum":"0358c397f258aa5fe33a351074ede7f2029f14cf","tarball":"https://registry.npmjs.org/tmijs-commander/-/tmijs-commander-2.2.3.tgz","fileCount":17,"unpackedSize":15970,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfX+LNCRA9TVsSAnZWagAAuIIQAJ9f6O8JxKjvFV5dOncg\n8YvENz3Mye4D6EpU0xpHQbOy7/6QET7/SPZDUUBIlrxfz4hSiw4kCCLnk+fE\nHkWsBjOs+D8Awch3ho+K1UzxmFLaSxnUfjXvPhDnkdwfiwnw+9lG9yFrFfpy\n76I67sTb164ROoRZRmiqzsmibySuorMzrkbVoLaJ9DBkeN4/w3UWMbcszTEx\nz685CKko3F8ozbeiJ+EHUVK/CgJRjtlb4DQ3gFcNrucBXzqjAnHCip/es583\nnMDGDExo/JUgPYg3l+K+6ZtuilLQT7/hT9bQfTizJK+TAQ+s3XFdSBcAlhws\nqBQFan9BLh3wmklh++riE5FvN+y4lYTo8f8nz7jfDHN2CnVZb2+VrCou3q7F\nZXk3/ahCB8iaacufme27uMmjoyKMoK+uRTKJc87glGesTfIdxbu/3dRfpUXr\nudcw+z269QiY6MDbTFJG9p8VFf7InzZuSMp7QasK8VGKDQOQ44rDiC99FTzN\nzXRMC8WurKiWxwMR4M8MDA4j2NA+WBwBhpOF3ce/x2lT+PhGKmGIr3E+TjNo\nL4y34WJIAQlocXEH7VK89qYQF6bqqWXMnun97IGxkr47ykFDA3gTiWtGBRHf\nT9glR+253Tn4kVnL99TT0XkxJDNzrIeYDcsMiBye5iP8EEp31lz6r6o/OxoM\nD42C\r\n=z56X\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFmH9P/mWbA9VyYNLOtGeLV1APlhhfTZVumHSwH6rkFSAiEA2TuNnzTA9VfER57mgFwWkjeT1l8+PBMF+1BNNRBROrU="}]},"maintainers":[{"name":"zyrakia","email":"ole.lammers@mail.com"}],"_npmUser":{"name":"zyrakia","email":"ole.lammers@mail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/tmijs-commander_2.2.3_1600119501152_0.03565836980364945"},"_hasShrinkwrap":false}},"time":{"created":"2020-07-19T22:10:06.829Z","1.0.0":"2020-07-19T22:10:06.941Z","modified":"2022-05-21T23:15:47.930Z","1.0.1":"2020-07-19T22:29:44.529Z","1.0.2":"2020-07-19T22:40:36.723Z","1.0.3":"2020-07-19T22:59:42.086Z","1.0.4":"2020-07-19T23:08:40.921Z","1.0.5":"2020-07-19T23:17:23.025Z","1.1.0":"2020-07-20T00:08:41.091Z","1.1.1":"2020-07-20T01:16:01.015Z","1.1.2":"2020-07-20T01:18:59.238Z","1.1.3":"2020-07-20T04:50:29.501Z","1.1.4":"2020-07-20T17:32:55.322Z","1.1.5":"2020-07-21T14:03:53.853Z","2.0.0":"2020-07-22T16:49:41.637Z","2.0.1":"2020-07-22T16:58:22.831Z","2.0.2":"2020-07-23T02:48:26.265Z","2.0.3":"2020-07-23T04:38:03.164Z","2.0.4":"2020-07-23T04:50:11.129Z","2.0.5":"2020-07-23T16:32:54.462Z","2.0.6":"2020-07-23T17:09:15.757Z","2.0.7":"2020-07-24T03:38:04.371Z","2.1.0":"2020-07-24T05:12:25.115Z","2.1.1":"2020-07-24T05:14:16.462Z","2.1.2":"2020-07-24T05:55:05.405Z","2.2.0":"2020-07-24T06:08:06.510Z","2.2.2":"2020-07-24T06:20:35.171Z","2.2.3":"2020-09-14T21:38:21.283Z"},"maintainers":[{"name":"zyrakia","email":"ole.lammers@mail.com"}],"description":"A simple library to easily implement commands into a TMIJS client.","homepage":"https://github.com/Zyrakia/TMIJS-Command-Manager#readme","keywords":["tmi","tmijs","tmi.js","twitch","twitch.tv","manager","commander"],"repository":{"type":"git","url":"git+https://github.com/Zyrakia/TMIJS-Command-Manager.git"},"author":{"name":"Zyrakia","email":"mailzyrakia@gmail.com","url":"https://zyrakia.github.io/"},"bugs":{"url":"https://github.com/Zyrakia/TMIJS-Command-Manager/issues"},"license":"MIT","readme":"[![Npm Version](https://img.shields.io/npm/v/tmijs-commander.svg?style=flat)](https://www.npmjs.org/package/tmijs-commander) [![Downloads](https://img.shields.io/npm/dm/tmijs-commander.svg?style=flat)](https://www.npmjs.org/package/tmijs-commander)\r\n\r\n## Introduction\r\n\r\nCommander is a library to simplify command integration into a [tmi.js](https://github.com/tmijs/tmi.js) client (Twitch Bot).\r\n\r\nFeatures:\r\n\r\n-   Easily register chat commands\r\n-   Parse arguments into an accessible array\r\n-   Handle command execution with a class or function\r\n-   Limit a command to only work in certain channels\r\n-   Disable and enable commands through code\r\n-   Written in Typescript, with type definitions included\r\n\r\n## Installation\r\n\r\n**NPM**\r\n\r\n```bash\r\n$ npm i tmijs-commander --save\r\n```\r\n\r\n**YARN**\r\n\r\n```bash\r\n$ yarn add tmijs-commander\r\n```\r\n\r\n**Build Yourself (Windows / [Git ](https://git-scm.com/downloads) / [NodeJS](https://nodejs.org/en/download/) )**\r\n\r\n```bash\r\n$ git clone https://github.com/Zyrakia/TMIJS-Commander.git\r\n$ cd tmijs-commander\r\n$ npm install\r\n```\r\n\r\n## Get Started\r\n\r\nView the quick start guide below, or view the full [docs](https://zyrakia.github.io/TMIJS-Commander/) to get a broader insight on what Commander can do for you.\r\n\r\n## Quick Start\r\n\r\nThis snippet demonstrate how to register the command `!hello` to your client. I will be using Typescript, because it is what the library is built it, and I highly recommend you do the same.\r\n\r\n```javascript\r\nimport tmi from \"tmi.js\"\r\nimport { Commander, CommandExecutor, CommandOrigins } from \"tmijs-commander\";\r\n\r\nconst options = {YOUR CLIENT OPTIONS HERE};\r\nconst client = tmi.client(options);\r\n\r\nclient.connect().then(() => {\r\n    const commander = new Commander(client);\r\n    commander.registerCommand(\"!hello\", new HelloCommand());\r\n});\r\n\r\nclass HelloCommand extends CommandExecutor {\r\n    public invoke(origins: CommandOrigins) {\r\n        origins.client.say(origins.channel, \"Hello World!\");\r\n    }\r\n}\r\n```\r\n\r\nWhen a user now executes the command `!hello` the `invoke` method will be called on the linked executor, which says `Hello World!` in the channel that the command was sent in.\r\n","readmeFilename":"README.md"}