![](\"https://img.shields.io/npm/v/@caldwell619/ms\")
\n \n
\n \n\n \n \n ![](\"https://img.shields.io/bundlephobia/min/@caldwell619/ms\")
\n \n ![](\"https://codecov.io/gh/christopher-caldwell/ms/branch/master/graph/badge.svg?token=2LA7ETDPO3\"){kind=icon}
\n ![](\"https://img.shields.io/github/last-commit/christopher-caldwell/ms\")
\n ![](\"https://img.shields.io/npm/types/@caldwell619/ms\")
\n\n\n## Installation\n\n```bash\n# Yarn\nyarn add @caldwell619/ms\n\n# NPM\nnpm install --save @caldwell619/ms\n```\n\n## Usage\n\n2 main utilities are exposed:\n\n```ts\nimport { convertTimeToMs, convertMsToTime } from '@caldwell619/ms'\n```\n\nThe only required argument is the input to be converted.\n\nAccepted types are `string` | `number`\n\n### Converting logical units to milliseconds\n\n[Full list of supported units](#supported-units)\n\n```ts\nimport { convertTimeToMs } from '@caldwell619/ms'\n\nconvertTimeToMs('5s') // 5000\nconvertTimeToMs('1m') // 60000\nconvertTimeToMs('10h') // 36000000\nconvertTimeToMs('2 days') // 172800000\nconvertTimeToMs('1y') // 31557600000\nconvertTimeToMs('-1h') // -3600000\n```\n\n### Number as milliseconds\n\n```ts\nimport { convertMsToTime, convertTimeToMs } from '@caldwell619/ms'\n\nconvertMsToTime(60000) // \"1m\"\nconvertMsToTime(2 * 60000) // \"2m\"\nconvertMsToTime(-3 * 60000) // \"-3m\"\nconvertMsToTime(convertTimeToMs('10 hours')) // \"10h\"\n```\n\n#### Optional Configuration\n\nThe config is optional, as is every key in the config\n\n| Argument | Type | |\n| --------------- | ------------------------------------------ | ----------------------------------------------------- |\n| `long` | `boolean` | If present, will return the long version of the unit. |\n| `preferredUnit` | `'ms', 's', 'm', 'h', 'w', 'd', 'mo', 'y'` | The supported unit you'd like the value returned in. |\n\n##### Long\n\nThis will print the value as `hours`, `minutes` as opposed to `h`, `m`.\n\n```ts\nconvertMsToTime(60000, { long: true }) // \"1 minute\"\nconvertMsToTime(2 * 60000, { long: true }) // \"2 minutes\"\nconvertMsToTime(-3 * 60000, { long: true }) // \"-3 minutes\"\nconvertMsToTime(convertTimeToMs('10 hours'), { long: true }) // \"10 hours\"\n```\n\n##### Preferred Unit\n\nThis is a working progress. It is implemented, but possibly not the way you'd like. Feel free to submit an [issue](https://github.com/christopher-caldwell/ms/issues/new) or [PR](https://github.com/christopher-caldwell/ms/compare) with how you'd like it done.\n\nIf provided, it will attempt to match the value with the given unit.\n\n###### Example\n\nFor example, if your value resolves to `15 days`, that is also `2 weeks`. The default will return as `2 weeks`. This is the largest bucket the time can be put into.\n\nThis can be overridden with providing your `preferredUnit`.\n\n```ts\nconvertMsToTime(7200000) // \"2h\"\nconvertMsToTime(7200000, { preferredUnit: 'm' }) // \"120m\"\nconvertMsToTime(7200000, { preferredUnit: 'm', long: true }) // \"120 minutes\"\n```\n\n###### Edge Cases\n\nIf your provided unit doesn't meet the requirement, meaning that the value cannot get to a full count of your unit, it will default to the next closest one.\n\n```ts\nconvertMsToTime(7200000) // \"2h\"\nconvertMsToTime(7200000, { preferredUnit: 'd' }) // \"2h\"\nconvertMsToTime(7200000, { preferredUnit: 'd', long: true }) // \"2 hours\"\n```\n\nIn this example, 2 hours cannot be represented as a `> 1 day`. This is where the funny business is, because maybe you'd prefer `0.08d` instead of defaulting to `2h`.\n\nMy preference is the latter, so :man_shrugging:\n\n## Supported Units\n\nThe following unites are supported for `convertTimeToMs`\n\n### Years\n\n`years`, `year`, `yrs`, `yr` `y`\n\n### Months\n\n`months`, `month`, `mon`, `mo`\n\n### Weeks\n\n`weeks`, `week`, `wks`, `wk`, `w`\n\n### Days\n\n`days`, `day`, `d`\n\n### Hours\n\n`hours`, `hour`, `hrs`, `hr`, `h`\n\n### Minutes\n\n`minutes`, `minute`, `mins`, `min`, `m`\n\n### Seconds\n\n`seconds`, `second`, `secs`, `sec`, `s`\n\n### Milliseconds\n\n`milliseconds`, `millisecond`, `msecs`, `msec`, `ms`\n","readmeFilename":"README.md"}