{"_id":"@caltrop/ms.js","_rev":"3-6eb3b4506f46f87bdfd1965d09b9dd1f","name":"@caltrop/ms.js","dist-tags":{"latest":"1.0.2"},"versions":{"1.0.0":{"name":"@caltrop/ms.js","version":"1.0.0","description":"A small module which handles time conversion for you","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"git+https://github.com/CaltropUwU/ms.js.git"},"keywords":["time","ms","converter","input","delay","dates"],"author":{"name":"Caltrop","email":"caltropuwu@gmail.com"},"license":"ISC","dependencies":{"basic":"^2.0.3","match-sorter":"^4.0.1"},"bugs":{"url":"https://github.com/CaltropUwU/ms.js/issues"},"homepage":"https://github.com/CaltropUwU/ms.js","_id":"@caltrop/ms.js@1.0.0","_npmVersion":"6.4.1","_nodeVersion":"10.15.3","_npmUser":{"name":"caltrop","email":"caltropuwu@gmail.com"},"dist":{"integrity":"sha512-tK7Hvjmg8shifjLUDgQMAf4Lu6vvGECIoS/S26LJ5skjY2f4D2t7cC7HosR9idmXMRRdUMDGYgTrvMytdvvoYg==","shasum":"ec0be8d9b770d8052b8e90a61a855243c978dbee","tarball":"https://registry.npmjs.org/@caltrop/ms.js/-/ms.js-1.0.0.tgz","fileCount":3,"unpackedSize":10380,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJddO/7CRA9TVsSAnZWagAAJ3gP/ihEkJVVi4EpW0++Qabr\nrbryHsHNoN6lb5Z/j4A9Kl++8+n4Co8vHS4YhNWnLKjWW6/oukaM9wlHkYtj\nF6bkzr95FxsXmhxAu9rGK9c1ms1YlMPU26zQGrDEr2WeA7RxEq8xTG0k2Wj/\nKJwtiyr7/JxOPPHbSDBrKz7H8FCwN+rbowuGxp11DFlTcd/+99+FB8XhGlKW\nHXrV6dyr/eK2csAgUKe3JpBAT8fwjQgXaohSgqMqxIyin6bHgXMYdaSRlnze\nTVQm6ZPhjb8njkBVKQNV4Czi9saXfXu5gfyD6CRZ7vo+qSAapZwiyRaiiadO\nDr1/A5lzddopIAfqhve4TYHTwTX84HmeP7YFjcg5HUo9NH9vAx7AkNvY2PwN\nJ9pMrCMJLWVRUBZmGHA55l7Xo+s9DFW7/ksE0HCMdrFG+aclvPyh9cCIdcRF\nu14zIyg6+/W0DJsS9ej/ZsMEmXGH6ukY0YTpoeHrFfJhgwa0smj4Q3SiUstC\nImB/XHV6gJO7YGEHv2mI545UxiyqGEuQo4iJ01dREMiEoFEEdbcgYx5K7eKF\nLMlp8ArTgGaCVz0noj7NDvSxr3/hx9w/38XcADoRg/FpBWPw2g6mrafEGUyr\nZO0LZqF5NOq8lWhQOnclTHLhX2k3wPY8ON7RXilckg9Fywc3tHY5fvrDrNFT\nf2DB\r\n=r2Ag\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHtzJmqhAQRIdhwXpJ1Q2R+KlpTHHl6/iVu+L9jyVK6OAiEAnXDaRe5hqC+pQsNi9CZ0PkM+TihGnx2hoUm06kIusXM="}]},"maintainers":[{"name":"caltrop","email":"caltropuwu@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ms.js_1.0.0_1567944698829_0.2856664672848468"},"_hasShrinkwrap":false},"1.0.1":{"name":"@caltrop/ms.js","version":"1.0.1","description":"A small module which handles time conversion for you","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"git+https://github.com/CaltropUwU/ms.js.git"},"keywords":["time","ms","converter","input","delay","dates"],"author":{"name":"Caltrop","email":"caltropuwu@gmail.com"},"license":"ISC","dependencies":{"match-sorter":"^4.0.1"},"bugs":{"url":"https://github.com/CaltropUwU/ms.js/issues"},"homepage":"https://github.com/CaltropUwU/ms.js","_id":"@caltrop/ms.js@1.0.1","_npmVersion":"6.4.1","_nodeVersion":"10.15.3","_npmUser":{"name":"caltrop","email":"caltropuwu@gmail.com"},"dist":{"integrity":"sha512-/1UvTPZ3INPudEHyVsEvk3z9s+qNCcv9q019jiolFpEllrMdcnAeM9IEt2ZvVAz0eqW1ve6d1l+d4yQ8ejUosw==","shasum":"58d41c7b457c3b1999ae13227595590d0afc7b3b","tarball":"https://registry.npmjs.org/@caltrop/ms.js/-/ms.js-1.0.1.tgz","fileCount":3,"unpackedSize":10628,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJddPDoCRA9TVsSAnZWagAAdfgQAIIO105Z4v1GcoVOlIQr\n7RwQX7BRsL5DNJ/wA6/L3VsWWjXjxr3okz2C4P7eReuxk/DM63erbWOwnnWj\n6e6tHIL4du3+WsvyoHDZOk3NuX9tAbySuV8mwYXeCpPO41LOJgREkD/J9Sxi\nLuBXRVnpk9Ull6JtuSR0gD02AtxtEZ0WS6saRSar4pNfj6mY4Q2XPPbeydVA\neBUy5Afw1AuHRIZ4urQB04noE2COwnzYQx4Pbm/v6ld3UO724VM0j4i7he2v\na7i1a1TKmsnTnf4t17xrXNF4BDFt/a4JkODhuNmG2d91xIyRAS703Yid+80P\ncADAM74auZM/KnNGEY55NA+RlGmnKPGcbUE159dvhvDR3wTtVd+ECxEWyd8h\n3MyY3NbpdS7URkr4Ti/7Ggh39eSXle8ENpFZLeGKvzKPqhjqGf4HkA5Pb9RL\nxjQbXmi76vB0/fknLF3WproafSBMDt6CkPGSYERNJMiLe+ohQXCPDYPlhaVd\nuN1OAZcZ/VgDCOsGU4evmGVC2fqLLKYEU7P9LsrUNyypwxqW9UNv+LcJnhMs\n1VCmJcro5mTvWHII9LUkgjUaWRmNdkwkJY9Pe/FG0jOegXdjXd7Xdt3eyisA\nfP2JuHGPgM01oHLz6ZZ9cVC1DZW17Ia+EBo/yMbvrPoOFBSNhdOpssFD3Nkr\n2HXW\r\n=z0Y9\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIEgYWW3xgAhY1JlRxLTrw9nGqIXIFpKsGIur80I4wrEbAiAiAKisJSIRsyCTYV4OS8CcMeDrEobpTpH3yRbuqnv3bQ=="}]},"maintainers":[{"name":"caltrop","email":"caltropuwu@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ms.js_1.0.1_1567944935961_0.5314802239739347"},"_hasShrinkwrap":false},"1.0.2":{"name":"@caltrop/ms.js","version":"1.0.2","description":"A small module which handles time conversion for you","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"git+https://github.com/CaltropUwU/ms.js.git"},"keywords":["time","ms","converter","input","delay","dates","parse","userinput","utility"],"author":{"name":"Caltrop","email":"caltropuwu@gmail.com"},"license":"ISC","dependencies":{"match-sorter":"^4.0.1"},"bugs":{"url":"https://github.com/CaltropUwU/ms.js/issues"},"homepage":"https://github.com/CaltropUwU/ms.js","_id":"@caltrop/ms.js@1.0.2","_npmVersion":"6.4.1","_nodeVersion":"10.15.3","_npmUser":{"name":"caltrop","email":"caltropuwu@gmail.com"},"dist":{"integrity":"sha512-BFgZ+8t0cxan61oizT+DoMA2nGL6n5eNXLq4arscXaio66y10h76BcXOTxnzFOz08rgJlDi+pchSfPo1EuX2zw==","shasum":"50ef79616c79e11238f59c5ff74dfd5ab348c449","tarball":"https://registry.npmjs.org/@caltrop/ms.js/-/ms.js-1.0.2.tgz","fileCount":3,"unpackedSize":11849,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJddQpuCRA9TVsSAnZWagAAKVoP/0lJJSQc8/hxWT4wKjAI\nTvu9WlRupesw2XA6MLC+xahxXKRwEtUTWh37342kxBshHGLjXm6AH5soLpS1\nzrXkrxrZ8Cpj/am1UTXbYgcz0GdqFGS8oT1hVOj3v0x3KqOMyI/4Sw5NumqY\nXTcaLnYb+3McAFTTVaNRidaFh3L6B0UmWrY/1gZpcLqryB+FsEkHERKw9LU3\nr6syPb2VcLxAYOy6Ol0bnsiSb9OYzSWMUYN8tNQM13GK0/omiXTiFX1mVfo2\n8FZWHuYdNg7n+DYj+vAmpccEAmjtebaHgQzbEPShANm43OfcbxmSOnLnX24G\nmiF9iB7gDSuBVFJZ0aJPn/EsBbh8nb7uX7N+StJdR+nq0ed+PNhl/yAYBB+4\nxohlufWlUhPpQc5aHobCxprZTcEPdm90N7/IVdzo+rTBxr1FlajpUC/eR8L+\nacVfLLDDWJdFgetH6ET6b8Jr6YtsxTUP6h3+1ipbMcIYYXcbZwbptI7kfafb\nbEhlrz+ghSgiRq+sUhXjwowYNTePT4KkU6NG67AqOSLVgFPoXiVvsGHdAEnI\nCha1VVuGEiz/465k1fVqLvyX2Xes0WCTrZ6awQIgmP82sFZA6vWNXh4NK39A\np8/mGYJsv6saTzoJ8dBQBIefkRMtlN2m9GTOkdQXAWNZ1KtMWo3yaExhDd6i\n4vxY\r\n=Hzge\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEfOv8qpObZz2V0365VgeD3Oor6Gy60M/RZAW4UQoqAYAiEA1ZVKfD1B+1nEEJatE99tiKX17LcfH8OrDrRPw2uNcUs="}]},"maintainers":[{"name":"caltrop","email":"caltropuwu@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ms.js_1.0.2_1567951470415_0.5961095149949904"},"_hasShrinkwrap":false}},"time":{"created":"2019-09-08T12:11:38.610Z","1.0.0":"2019-09-08T12:11:39.459Z","modified":"2022-04-04T21:33:29.729Z","1.0.1":"2019-09-08T12:15:36.057Z","1.0.2":"2019-09-08T14:04:30.560Z"},"maintainers":[{"name":"caltrop","email":"caltropuwu@gmail.com"}],"description":"A small module which handles time conversion for you","homepage":"https://github.com/CaltropUwU/ms.js","keywords":["time","ms","converter","input","delay","dates","parse","userinput","utility"],"repository":{"type":"git","url":"git+https://github.com/CaltropUwU/ms.js.git"},"author":{"name":"Caltrop","email":"caltropuwu@gmail.com"},"bugs":{"url":"https://github.com/CaltropUwU/ms.js/issues"},"license":"ISC","readme":"# ms.js\r\n\r\nA simple utility module which will help you implement time-based applications.\r\n\r\n# Table of Contents\r\n\r\n* [Installation](#Installation)\r\n* [Behaviour](#Behaviour)\r\n* [Input](#Input)\r\n  * [Examples](#Examples)\r\n  * [String input Units](#string-input-units)\r\n  * [Options](#Options)\r\n\r\n## Installation\r\n\r\n```\r\n$ npm install @caltrop/ms.js\r\n```\r\n\r\n## Behaviour\r\n\r\n**The function will always return a `Time` Object.**\r\n\r\nFor example:\r\n```js\r\nconst time = require('ms.js');\r\nconsole.log(time(5200));\r\n```\r\nwill return:\r\n```js\r\n{\r\n    eternity: 0,\r\n    aeon: 0,\r\n    century: 0,\r\n    decade: 0,\r\n    year: 0,\r\n    day: 0,\r\n    hour: 0,\r\n    minute: 0,\r\n    second: 5,\r\n    millisecond: 200,\r\n    microsecond: 0,\r\n    nanosecond: 0,\r\n    \r\n    ms: 5200,\r\n    str: '5 seconds and 200 milliseconds'\r\n}\r\n```\r\n\r\nInvoking the `toString` function will always return the `.str` value.\r\nFor example:\r\n```js\r\nconst time = require('ms.js');\r\nconsole.log(`Shutting down in ${time(5200)}`); // => 'Shutting down in 5 seconds and 200 milliseconds'\r\n```\r\n\r\nInvoking the `valueOf` function will always return the `.ms` value.\r\nFor example:\r\n```js\r\nconst time = require('ms.js');\r\ntime(5200) + 300; // => 5500\r\n```\r\n\r\n## Input\r\n\r\nValid Input is always either a `Number` or a `String`!\r\n\r\n### Examples\r\n```js\r\nconst time = require('ms.js');\r\n\r\ntime(1000).str;                            // => '1 second'\r\ntime(1000 * 60).str;                       // => '1 minute'\r\ntime('2 hours').ms;                        // => 7200000\r\ntime('50y, 30h, 20m, 10s').str;            // => '5 decades, 1 day, 6 hours, 20 minutes and 10 seconds'\r\ntime('30 hours, 20 min10seconds5 0y').str; // => '5 decades, 1 day, 6 hours, 20 minutes and 10 seconds'\r\ntime(time('2 hours') + time(10000)).str;   // =>  '2 hours and 10 seconds'\r\ntime('-3 days').ms;                        // => -259200000\r\ntime('20').str;                            // => '20 minutes'\r\ntime(20).str;                              // => '20 milliseconds'\r\ntime(2.5).str;                             // => '2 milliseconds and 500 microseconds'\r\ntime('2.5 hours').str;                     // => '2 hours and 30 minutes'\r\ntime('minute').ms                          // => 60000\r\ntime(Infinity).str                         // => '1 eternity'\r\n\r\n// you may also parse a Date Object\r\n`it has been ${time(Date.now() - new Date(1567951242668))} since ms.js was released!`\r\n```\r\n(assuming that all relevant values will be shown, see: [Options](#Options) section)\r\n\r\n### String input Units\r\n\r\nUnit Name | Definition | Aliases\r\n---|---|---\r\nEternity | An Infinite amount of time | eternites\r\nAeon | `3.1536e+19 ms` or 1 billion years | `ae`,`æ`, `aeons`, `eon`, `eons`\r\nMillenium | `3.1536e+13 ms` or 1,000 years | `ml`, `milleniums`, `millennia`\r\nCentury | `3.1536e+12 ms` or 100 years | `l`, `cent`, `centurys`, `centuries`\r\nGeneration | `1103760000000 ms` or 3 decades and 5 years | `generations`\r\nDecade | `3.1536e+11 ms` or 10 years | `dc`, `decades`\r\nMegaminute | `60000000000 ms` or 1,000,000 minutes or about 1 year and 329 days | `megaminutes`\r\nYear | `3.1536e+10 ms` or 365 days | `y`, `yr`, `yrs`, `years`\r\nSeason | `7884086400 ms` or about 91 days and 6 hours | `quarter`, `trimonth`\r\nMonth | `2628028800 ms` or about 30 days and 10 hours | `mo`, `mon`, `months`\r\nLunar Month | `2449440000 ms` or about 28 days and 8 hours | `lunarmonth`, `lunarmonths`\r\nFortnight | `1209600000 ms` or 14 days | `biweek`, `fortnights`, `biweeks`\r\nWeek | `604800000 ms` or 7 days | `w`, `weeks`\r\nDay | `86400000 ms` or 24 hours | `d`, `days`\r\nHour | `3600000 ms` or 60 minutes | `h`, `hr`, `hrs`, `hours`\r\nMoment | `90000 ms` or 1 minute and 30 seconds | `moments`\r\nMinute | `60000 ms` or 60 seconds | `m`, `mn`, `min`, `mins`, `minutes`\r\nInstant | `8000 ms` or 8 seconds | `in`, `instants`\r\nSecond | `1000 ms` | `s`, `sec`, `secs`, `seconds`\r\nMillisecond | `1 ms` | `ms`, `msec`, `msecs`, `milliseconds`\r\nMicrosecond | `0.001 ms` | `µs`, `micro`, `micros`, `microsec`, `microsecs`,`microseconds`\r\nNanosecond | `0.000001 ms` or 0.001 microseconds | `ns`, `nano`, `nanos`, `nanosec`, `nenosecs`,`nanoseconds`\r\n\r\nInput is case insensitive!\r\n\r\nIf none of these are found directly, it will try to match the most similar unit instead (Assuming that strict mode is disabled, see: [Options](#Options) section)\r\n\r\n### Options\r\n\r\nOptions are parsed in an Object as the 2nd parameter to the function.\r\n\r\nOption Name | Purpose | Default\r\n---|---|---\r\nverbose | Whether or not to show the entire Unit name or to use a shortened name | `true`\r\nrelevant | How many relevant Units to display in the String | `2`\r\nstrict | Whether or not to limit the use of incomplete input for String input | `false`\r\n\r\n**Examples:**\r\n```js\r\nconst time = require('ms.js');\r\n\r\ntime(55555, {verbose: true}).str    // => '55 seconds and 555 milliseconds'\r\ntime(55555, {verbose: false}).str   // => '55s, 555ms'\r\n\r\ntime(55555555, {relevant: 2}).str   // => '15 hours and 25 minutes'\r\ntime(55555555, {relevant: 3}).str   // => '15 hours, 25 minutes and 55 seconds'\r\ntime(55555555, {relevant: 4}).str   // => '15 hours, 25 minutes, 55 seconds and 555 milliseconds'\r\n\r\ntime('minute', {strict: false}).str // => '1 minute'\r\ntime('1', {strict: false}).str      // => '1 minute'\r\ntime('1minu', {strict: false}).str  // => '1 minute'\r\ntime('minute', {strict: true}).str  //TypeError: Cannot read property 'str' of undefined\r\ntime('1', {strict: true}).str       //TypeError: Cannot read property 'str' of undefined\r\ntime('1minu', {strict: true}).str   //TypeError: Cannot read property 'str' of undefined\r\n\r\n\r\ntime('66666', {strict: false, verbose: false, relevant: 99}) // => 46d, 7h, 6m\r\n```\r\n","readmeFilename":"readme.md"}