{"_id":"@kawu/console-kit","_rev":"44-5d4244fc06d81048cc3ce6946ac6f1d8","name":"@kawu/console-kit","dist-tags":{"latest":"11.0.5"},"versions":{"11.0.0":{"name":"@kawu/console-kit","version":"11.0.0","keywords":["console-kit","console","terminal"],"author":{"name":"kawu"},"license":"ISC","_id":"@kawu/console-kit@11.0.0","maintainers":[{"name":"kawu","email":"thomas.lessieu1@gmail.com"}],"homepage":"https://github.com/xkawu/console-kit#readme","bugs":{"url":"https://github.com/xkawu/console-kit/issues"},"dist":{"shasum":"0011ad863b249342b6e9ac4cde1148af8f01598f","tarball":"https://registry.npmjs.org/@kawu/console-kit/-/console-kit-11.0.0.tgz","fileCount":7,"integrity":"sha512-ilr4u5GpEkqvZkMNgsPRnufQBsh/1QR/y+Uah1q46+3KEmsoE4dh8CwAdS2pJMpRbbu9ffwOhNKDbb3aRNycjQ==","signatures":[{"sig":"MEUCIDPyNyI2CEVns0GqHJ1bMUx+WAX9BFgewqTyQ6Lvr8DpAiEAjYfZmM6VxTvIKktuTOtD/ehV+8r97Ijks4kUZ2nkEgk=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":22120},"main":"./dist/client.js","gitHead":"f0167f6d27ef228bb7832026e09569ed576f6747","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"_npmUser":{"name":"kawu","email":"thomas.lessieu1@gmail.com"},"repository":{"url":"git+https://github.com/xkawu/console-kit.git","type":"git"},"_npmVersion":"10.8.3","description":"A `fast`, `light weight`, `minimalist` and `reliable` module to log stuff easly and more understable.","directories":{},"_nodeVersion":"22.3.0","dependencies":{"chalk":"^4.1.2","dayjs":"^1.11.10","cli-select":"^1.1.2"},"_hasShrinkwrap":false,"devDependencies":{"@types/node":"^20.10.4"},"_npmOperationalInternal":{"tmp":"tmp/console-kit_11.0.0_1725462433719_0.37814992859196495","host":"s3://npm-registry-packages"}},"11.0.1":{"name":"@kawu/console-kit","version":"11.0.1","keywords":["console-kit","console","terminal"],"author":{"name":"kawu"},"license":"ISC","_id":"@kawu/console-kit@11.0.1","maintainers":[{"name":"kawu","email":"thomas.lessieu1@gmail.com"}],"homepage":"https://github.com/xkawu/console-kit#readme","bugs":{"url":"https://github.com/xkawu/console-kit/issues"},"dist":{"shasum":"1caf956787bcb5cd2e0cf046c98be51f3157c794","tarball":"https://registry.npmjs.org/@kawu/console-kit/-/console-kit-11.0.1.tgz","fileCount":8,"integrity":"sha512-MFRG9FccBhru7hRqypAFHiNwKz7gnZrMC9J8IiRpnjwiZeZjnxpNq1Ko7YF0a8q0hj82b6qih23yPACbqPrTDQ==","signatures":[{"sig":"MEUCICNE/awmh92yLOWMcouKeE89CBV8zdtXf7UmOAvLTEDCAiEAofz3j5gQRGivmrnvUkbjI+b06a+vzOodUeJ+myQDlk4=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":22120},"main":"./dist/client.js","types":"./dist/client.d.ts","gitHead":"105987ee18c09d984881b6e2680fd2924f15030f","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"_npmUser":{"name":"kawu","email":"thomas.lessieu1@gmail.com"},"repository":{"url":"git+https://github.com/xkawu/console-kit.git","type":"git"},"_npmVersion":"10.8.3","description":"A `fast`, `light weight`, `minimalist` and `reliable` module to log stuff easly and more understable.","directories":{},"_nodeVersion":"22.3.0","dependencies":{"chalk":"^4.1.2","dayjs":"^1.11.10","cli-select":"^1.1.2"},"_hasShrinkwrap":false,"devDependencies":{"@types/node":"^20.10.4"},"_npmOperationalInternal":{"tmp":"tmp/console-kit_11.0.1_1725462756439_0.7118458695608827","host":"s3://npm-registry-packages"}},"11.0.2":{"name":"@kawu/console-kit","version":"11.0.2","keywords":["console-kit","console","terminal"],"author":{"name":"kawu"},"license":"ISC","_id":"@kawu/console-kit@11.0.2","maintainers":[{"name":"kawu","email":"thomas.lessieu1@gmail.com"}],"homepage":"https://github.com/xkawu/console-kit#readme","bugs":{"url":"https://github.com/xkawu/console-kit/issues"},"dist":{"shasum":"dca7089ad186ff1ceef744a26c660cf84f235709","tarball":"https://registry.npmjs.org/@kawu/console-kit/-/console-kit-11.0.2.tgz","fileCount":8,"integrity":"sha512-+Qtv8V4zqsZ3cEuX0N2+6crO4lttlMuy2MRgKuANnr19RxsivX+odxZsxg6M6r/ykdP3SngvQUR1+cj1HYmj5A==","signatures":[{"sig":"MEUCIEUd0yY9BNWJU0qrKij0ERJ+ETwUHRRcB535/66Dk+wIAiEA4w4Bw3pX/FadMGkYfKq9aLvFqYZphaW2NJtrGCDNwyg=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":22157},"main":"./dist/client.js","types":"./dist/client.d.ts","gitHead":"c6274220c7eca79e064ade9fd7b7184e11e6fcc4","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"_npmUser":{"name":"kawu","email":"thomas.lessieu1@gmail.com"},"repository":{"url":"git+https://github.com/xkawu/console-kit.git","type":"git"},"_npmVersion":"10.8.3","description":"A `fast`, `light weight`, `minimalist` and `reliable` module to log stuff easly and more understable.","directories":{},"_nodeVersion":"22.3.0","dependencies":{"chalk":"^4.1.2","dayjs":"^1.11.10","cli-select":"^1.1.2"},"_hasShrinkwrap":false,"devDependencies":{"@types/node":"^20.10.4"},"_npmOperationalInternal":{"tmp":"tmp/console-kit_11.0.2_1725463644018_0.12021066447295525","host":"s3://npm-registry-packages"}},"11.0.3":{"name":"@kawu/console-kit","version":"11.0.3","keywords":["console-kit","console","terminal"],"author":{"name":"kawu"},"license":"ISC","_id":"@kawu/console-kit@11.0.3","maintainers":[{"name":"kawu","email":"thomas.lessieu1@gmail.com"}],"homepage":"https://github.com/xkawu/console-kit#readme","bugs":{"url":"https://github.com/xkawu/console-kit/issues"},"dist":{"shasum":"e4c3d238392bcb3064b44c01195c934f609dca66","tarball":"https://registry.npmjs.org/@kawu/console-kit/-/console-kit-11.0.3.tgz","fileCount":9,"integrity":"sha512-Pefsjwv3ZaMeB1g15NBJiyWjZR2RPm8atQDB97vwsAcKLqsMlpC0FmjlZdADkJPxA6P74/9zkvSn5lAWJHvfaA==","signatures":[{"sig":"MEQCIFNe3hD2LXyXfXVyhMqUja4rcHs45l1zYSC4Nu5KuBlVAiAW2gWmJx9yqpOcQvdyCt43drXKRv5Ce+96lIYQrBz0xg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":23666},"main":"./dist/client.js","types":"./dist/client.d.ts","gitHead":"63ff7b5e34af725a5a40a0ea56c3fd9c68f46542","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"_npmUser":{"name":"kawu","email":"thomas.lessieu1@gmail.com"},"repository":{"url":"git+https://github.com/xkawu/console-kit.git","type":"git"},"_npmVersion":"10.8.3","description":"A `fast`, `light weight`, `minimalist` and `reliable` module to log stuff easly and more understable.","directories":{},"_nodeVersion":"22.3.0","dependencies":{"chalk":"^4.1.2","dayjs":"^1.11.10","cli-select":"^1.1.2"},"_hasShrinkwrap":false,"devDependencies":{"@types/node":"^20.10.4"},"_npmOperationalInternal":{"tmp":"tmp/console-kit_11.0.3_1725471956493_0.7932208482092291","host":"s3://npm-registry-packages"}},"11.0.4":{"name":"@kawu/console-kit","version":"11.0.4","keywords":["console-kit","console","terminal"],"author":{"name":"kawu"},"license":"ISC","_id":"@kawu/console-kit@11.0.4","maintainers":[{"name":"kawu","email":"thomas.lessieu1@gmail.com"}],"homepage":"https://github.com/xkawu/console-kit#readme","bugs":{"url":"https://github.com/xkawu/console-kit/issues"},"dist":{"shasum":"e711caedc270e388c6d164a6a89f807ccea24a9e","tarball":"https://registry.npmjs.org/@kawu/console-kit/-/console-kit-11.0.4.tgz","fileCount":9,"integrity":"sha512-KdV2FyoIiqq2EruP7DGreFlW44kly3c92LXo+FrEFwiWD7yHyaFA0737guPksLl8XwNV3Rbkdvw74olua3H21g==","signatures":[{"sig":"MEYCIQCOsI/KUFKlkTsLfkzw/EgHwmsvaHRpZMCt7SQ9cI6NhwIhAOlxHqdbmG1glKTyno0LnLEcatXh0abMR9i0VIJ46aY0","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":23715},"main":"./dist/client.js","types":"./dist/client.d.ts","gitHead":"fbcafe825e2817c6c2522d1716e2f5bc0e9f5a63","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"_npmUser":{"name":"kawu","email":"thomas.lessieu1@gmail.com"},"repository":{"url":"git+https://github.com/xkawu/console-kit.git","type":"git"},"_npmVersion":"10.8.3","description":"A `fast`, `light weight`, `minimalist` and `reliable` module to log stuff easly and more understable.","directories":{},"_nodeVersion":"22.3.0","dependencies":{"chalk":"^4.1.2","dayjs":"^1.11.10","cli-select":"^1.1.2"},"_hasShrinkwrap":false,"devDependencies":{"@types/node":"^20.10.4"},"_npmOperationalInternal":{"tmp":"tmp/console-kit_11.0.4_1725472979899_0.8816591569441885","host":"s3://npm-registry-packages"}},"11.0.5":{"dependencies":{"chalk":"^4.1.2","cli-select":"^1.1.2","dayjs":"^1.11.10"},"devDependencies":{"@types/node":"^20.10.4"},"version":"11.0.5","name":"@kawu/console-kit","description":"A `fast`, `light weight`, `minimalist` and `reliable` module to log stuff easly and more understable.","main":"./dist/client.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"git+https://github.com/xkawu/console-kit.git"},"keywords":["console-kit","console","terminal"],"author":{"name":"kawu"},"license":"ISC","bugs":{"url":"https://github.com/xkawu/console-kit/issues"},"homepage":"https://github.com/xkawu/console-kit#readme","_id":"@kawu/console-kit@11.0.5","gitHead":"3e858010244cc188bf213f36a4f6426b4dc30193","types":"./dist/client.d.ts","_nodeVersion":"22.3.0","_npmVersion":"10.8.3","dist":{"integrity":"sha512-BaVCBH40vgO5cZ6Va3oMby43VnOmaU6hJjAeAaY28KoZMTK6w9lEekPfTaXrpg40t4Ckdm+62eE2/iS+6eU8Fw==","shasum":"2710f73f230c3f4a20c899528929cb213f9fab9b","tarball":"https://registry.npmjs.org/@kawu/console-kit/-/console-kit-11.0.5.tgz","fileCount":9,"unpackedSize":23749,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCmaXZjOvRc1BZ9z2xqgnC8H5BKu1sJ+ylndhYSrMvQ9gIhAPxlJUXwv6yTpG9U2HsZF1/ZJzZnm6pBNqDpUuoOJ5Xh"}]},"_npmUser":{"name":"kawu","email":"thomas.lessieu1@gmail.com"},"directories":{},"maintainers":[{"name":"kawu","email":"thomas.lessieu1@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/console-kit_11.0.5_1725475778561_0.11608392609496754"},"_hasShrinkwrap":false}},"time":{"created":"2024-09-04T15:07:13.591Z","modified":"2024-09-04T18:49:38.992Z","0.0.1":"2023-12-17T15:56:18.676Z","0.0.2":"2023-12-17T16:05:45.976Z","0.0.3":"2023-12-17T16:35:20.193Z","0.0.4":"2023-12-17T16:39:23.829Z","0.0.5":"2023-12-17T16:55:16.718Z","0.0.6":"2023-12-17T17:01:04.263Z","0.0.7":"2023-12-17T17:02:51.734Z","0.0.8":"2023-12-17T20:31:14.616Z","0.0.9":"2023-12-17T21:04:54.587Z","1.0.0":"2023-12-17T21:12:26.306Z","1.0.1":"2023-12-17T22:36:58.906Z","1.1.0":"2023-12-18T19:37:51.078Z","1.1.5":"2023-12-18T19:47:42.417Z","1.2.5":"2024-02-13T19:16:05.740Z","1.5.2":"2024-03-23T19:20:29.668Z","1.5.3":"2024-03-23T19:25:39.202Z","1.7.2":"2024-06-14T13:50:42.458Z","1.7.3":"2024-06-14T13:54:10.051Z","1.8.1":"2024-06-14T14:34:20.462Z","2.0.0":"2024-06-14T18:23:27.029Z","2.5.2":"2024-06-21T13:46:08.053Z","3.5.2":"2024-06-24T21:32:47.504Z","3.5.3":"2024-06-24T21:34:54.419Z","3.8.3":"2024-06-24T21:36:23.230Z","3.8.4":"2024-09-04T13:02:15.025Z","3.8.5":"2024-09-04T13:07:10.764Z","3.8.6":"2024-09-04T13:10:54.415Z","3.8.7":"2024-09-04T13:21:22.840Z","3.8.8":"2024-09-04T13:28:30.265Z","3.8.9":"2024-09-04T13:36:08.667Z","3.9.1":"2024-09-04T13:43:18.460Z","3.9.2":"2024-09-04T13:49:21.091Z","10.0.0":"2024-09-04T14:12:35.661Z","10.0.1":"2024-09-04T14:18:46.605Z","10.0.2":"2024-09-04T14:31:14.192Z","10.0.3":"2024-09-04T14:34:34.829Z","11.0.0":"2024-09-04T15:07:13.910Z","11.0.1":"2024-09-04T15:12:36.593Z","11.0.2":"2024-09-04T15:27:24.215Z","11.0.3":"2024-09-04T17:45:56.626Z","11.0.4":"2024-09-04T18:03:00.060Z","11.0.5":"2024-09-04T18:49:38.801Z"},"bugs":{"url":"https://github.com/xkawu/console-kit/issues"},"author":{"name":"kawu"},"license":"ISC","homepage":"https://github.com/xkawu/console-kit#readme","keywords":["console-kit","console","terminal"],"repository":{"type":"git","url":"git+https://github.com/xkawu/console-kit.git"},"description":"A `fast`, `light weight`, `minimalist` and `reliable` module to log stuff easly and more understable.","maintainers":[{"name":"kawu","email":"thomas.lessieu1@gmail.com"}],"readme":"# Console-kit\r\n\r\nA `fast`, `light weight`, `minimalist` and `reliable` module to log stuff easly and more understable.\r\n\r\n## Installation\r\n\r\nUse this command to add Console-kit\r\n\r\n```bash\r\n  npm i @kawu/console-kit\r\n```\r\n\r\n## Usage\r\n\r\n### TS\r\n\r\n```ts\r\nimport { ConsoleKit } from \"@kawu/console-kit\";\r\nconst consoleKit = new ConsoleKit();\r\n```\r\n\r\n### JS\r\n\r\n```js\r\nconst { ConsoleKit } = require(\"@kawu/console-kit\");\r\nconst consoleKit = new ConsoleKit();\r\n```\r\n\r\n## Logging\r\n\r\nWhen logging what's going on in your application is crucial, I have dedicated functions for every situation.\r\n\r\n![Example](https://i.imgur.com/oFEckxL.png)\r\n\r\n![Example](https://i.imgur.com/iTBJ0xO.png)\r\n\r\n### Comments\r\n\r\n```js\r\nconsoleKit.comment(CommentOptions);\r\n```\r\n\r\n```ts\r\n// CommentOptions\r\n\r\nmessage: string;\r\ntimestamp: boolean; // Not required\r\n```\r\n\r\n### Success\r\n\r\n```js\r\nconsoleKit.success(CheckOptions);\r\n```\r\n\r\n```ts\r\n// CheckOptions\r\n\r\nmessage: string;\r\ntimestamp: boolean; // Not required\r\n```\r\n\r\n### Info\r\n\r\n```js\r\nconsoleKit.info(InfoOptions);\r\n```\r\n\r\n```ts\r\n// InfoOptions\r\n\r\nmessage: string;\r\ntimestamp: boolean; // Not required\r\n```\r\n\r\n### Warn\r\n\r\n```js\r\nconsoleKit.warn(WarnOptions);\r\n```\r\n\r\n```ts\r\n// WarnOptions\r\n\r\nmessage: string;\r\ntimestamp: boolean; // Not required\r\n```\r\n\r\n### Error\r\n\r\n```js\r\nconsoleKit.error(ErrorOptions);\r\n```\r\n\r\n```ts\r\n// ErrorOptions\r\n\r\nmessage: string;\r\ntimestamp: boolean; // Not required\r\n```\r\n\r\n## Loading\r\n\r\nThis is kinda usefull to tell that your terminal is doing background stuff.\r\n\r\n![Example](https://i.imgur.com/FQbYMWk.png)\r\n\r\n### Start loader\r\n\r\n```js\r\nconsoleKit.startLoading(StartLoaderOptions);\r\n```\r\n\r\n```ts\r\n// StartLoaderOptions\r\n\r\nmessage: string;\r\ntimestamp: boolean; // Not required\r\n```\r\n\r\n### Stop loader\r\n\r\n```js\r\nconsoleKit.stopLoading(StopLoaderOptions);\r\n```\r\n\r\n```ts\r\n// StopLoaderOptions\r\n\r\nclearLine: boolean; // Remove the loading line if true\r\n```\r\n\r\n## Progress Bar\r\n\r\nLike the loading but we know when the loading will finish.\r\n\r\n![Example](https://i.imgur.com/kWWkqpQ.png)\r\n\r\n### Start progress bar\r\n\r\n```js\r\nconsoleKit.startProgress(StartProgressOptions);\r\n```\r\n\r\n```ts\r\n// StartProgressOptions\r\n\r\nmessage: string;\r\npercentage: number;\r\ntimestamp: boolean; // Not required\r\n```\r\n\r\n### Edit the actual progress bar\r\n\r\n```js\r\nconsoleKit.editProgress(EditProgressOptions);\r\n```\r\n\r\n```ts\r\n// EditProgressOptions\r\n\r\npercentage: number;\r\nmessage: string;\r\n```\r\n\r\n### End progress bar\r\n\r\n```js\r\nconsoleKit.endProgress(EndProgressOptions);\r\n```\r\n\r\n```ts\r\n// EndProgressOptions\r\n\r\nclearLine: boolean; // Remove the progress bar line if true\r\n```\r\n\r\n## Prompt\r\n\r\nIf your user need to give you data, then the prompt is a good way to go.\r\n\r\n![Example](https://i.imgur.com/g8pN4Fm.png)\r\n\r\n### Usage\r\n\r\n```js\r\nconsoleKit.prompt(PromptOptions);\r\n```\r\n\r\n```ts\r\n// PromptOptions\r\n\r\nmessage: string;\r\ncharacter: string; // Not required -- If you wish to replace \"?\", put your own icon here\r\n```\r\n\r\n### Output\r\n\r\n```ts\r\nstring;\r\n```\r\n\r\n## YesNo\r\n\r\nIt's like prompt but for boolean values.\r\n\r\n![Example](https://i.imgur.com/Clkw4bY.png)\r\n\r\n### Usage\r\n\r\n```js\r\nconsoleKit.yesno(YesNoOptions);\r\n```\r\n\r\n```ts\r\n// YesNoOptions\r\n\r\nmessage: string;\r\ndefaultValue: boolean; // true = yes | false = no\r\n```\r\n\r\n### Output\r\n\r\nIf the default value is `false` and the user send for example `lol` then the output will be `false` because he didn't put `no`/`n` or `yes`/`y`.\r\n\r\n```ts\r\nboolean;\r\n```\r\n\r\n## Select\r\n\r\nYou have a list and your user have to select an item inside a list, then this will do the job.\r\n\r\n![Example](https://i.imgur.com/KMQKo0q.png)\r\n\r\n```js\r\nconsoleKit.select(SelectOptions);\r\n```\r\n\r\n```ts\r\nvalues: Array<string>;\r\ndefaultValueIndex: number; // Not required -- Index number of the values array\r\nselectedText: string; // Not required -- Custom the \"[ • ]\" (Item selected)\r\nunselectedText: string; // Not required -- Custom the \"[  ]\" (Item not selected)\r\ncleanafter: boolean; // Not required -- Remove the selection of the terminal when user finished\r\n```\r\n","readmeFilename":"README.md"}