{"id":15637593,"url":"https://github.com/jonahsnider/convert","last_synced_at":"2025-05-15T21:04:05.217Z","repository":{"id":36996893,"uuid":"264621601","full_name":"jonahsnider/convert","owner":"jonahsnider","description":"The smallest \u0026 fastest library for really easy, totally type-safe unit conversions in TypeScript \u0026 JavaScript.","archived":false,"fork":false,"pushed_at":"2025-05-09T05:48:25.000Z","size":33486,"stargazers_count":149,"open_issues_count":8,"forks_count":21,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-05-09T06:26:17.864Z","etag":null,"topics":["conversion","conversions","convert","convert-units","hacktoberfest","javascript","metric","nodejs","si-units","typescript","unit-conversions","uom"],"latest_commit_sha":null,"homepage":"https://convert.js.org","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jonahsnider.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["jonahsnider"],"patreon":"jonahsnider","open_collective":null,"ko_fi":"jonahsnider","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2020-05-17T09:01:49.000Z","updated_at":"2025-05-09T05:48:16.000Z","dependencies_parsed_at":"2023-10-18T15:46:50.232Z","dependency_job_id":"2cdc6bab-2bae-463a-a2bb-17088b410f63","html_url":"https://github.com/jonahsnider/convert","commit_stats":{"total_commits":1953,"total_committers":11,"mean_commits":"177.54545454545453","dds":"0.24577572964669736","last_synced_commit":"1c783600bc552a0edfabd897db2f471ca236bb7e"},"previous_names":[],"tags_count":82,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonahsnider%2Fconvert","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonahsnider%2Fconvert/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonahsnider%2Fconvert/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonahsnider%2Fconvert/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jonahsnider","download_url":"https://codeload.github.com/jonahsnider/convert/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254422754,"owners_count":22068678,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["conversion","conversions","convert","convert-units","hacktoberfest","javascript","metric","nodejs","si-units","typescript","unit-conversions","uom"],"created_at":"2024-10-03T11:12:14.459Z","updated_at":"2025-05-15T21:04:05.193Z","avatar_url":"https://github.com/jonahsnider.png","language":"TypeScript","funding_links":["https://github.com/sponsors/jonahsnider","https://patreon.com/jonahsnider","https://ko-fi.com/jonahsnider"],"categories":["TypeScript"],"sub_categories":[],"readme":"# Convert\n\nThe [smallest](https://bundlephobia.com/package/convert) \u0026 [fastest](https://github.com/jonahsnider/js-unit-conversion-benchmarks) library for really easy, totally type-safe unit conversions in TypeScript \u0026 JavaScript.\n\n[![bundle size](https://img.shields.io/bundlephobia/minzip/convert)](https://bundlephobia.com/package/convert)\n[![npm monthly downloads](https://img.shields.io/npm/dm/convert)](https://www.npmjs.com/package/convert)\n\n```sh\nnpm install convert\n# or\nyarn add convert\n```\n\n[**More installation examples below**](#Installation).\n\n```js\nconvert(5, \"miles\").to(\"km\");\nconvertMany(\"4d 16h\").to(\"minutes\");\n```\n\n## Features\n\n- Full build time and runtime validation of conversions\n- Web frameworks like Next.js and Vite know that Convert is side-effect free, so [conversions will be precalculated at build-time](https://github.com/jonahsnider/convert/blob/main/docs/build-time-optimizations.tsx), absolutely zero conversion code is sent to clients\n- Runs anywhere (browsers, Node, Bun, etc), full ES3 backwards-compatibility\n- Tiny bundle size and 0 dependencies\n- Supports bigints\n\n## Usage\n\nGenerated API documentation for the latest version is available online.\n\n[**View docs**](https://convert.js.org).\n\n```ts\n// ESM:\nimport convert from \"convert\";\n// CJS:\nconst { convert } = require(\"convert\");\n\n// 360 seconds into minutes\nconvert(360, \"seconds\").to(\"minutes\");\n// -\u003e 6\n\n// BigInt support\nconvert(20n, \"hours\").to(\"minutes\");\n// -\u003e 1200n\n\n// Format to the best unit automatically\nconvert(5500, \"meters\").to(\"best\");\n// -\u003e { quantity: 5.5, unit: 'km', toString: () =\u003e '5.5 km' }\n\n// You can also do length, data, volume, mass, temperature, and more\nconvert(5, \"kilometers\").to(\"nautical miles\");\nconvert(12, \"pounds\").to(\"ounces\");\nconvert(8192, \"bytes\").to(\"KiB\");\nconvert(10, \"atmospheres\").to(\"kPa\");\nconvert(451, \"fahrenheit\").to(\"celsius\");\n```\n\n### Converting many units\n\n```ts\nimport { convertMany } from \"convert\";\nconst { convertMany } = require(\"convert\");\n\n// Convert 1 day and 8 hours into ms\nconvertMany(\"1d8h\").to(\"ms\");\n```\n\n### Converting to best unit\n\n```ts\nimport convert from \"convert\";\nconst { convert } = require(\"convert\");\n\n// Convert into the best unit\nconst duration = convert(36, \"h\").to(\"best\");\n// -\u003e { quantity: 1.5, unit: 'd', toString: () =\u003e '1.5 d' }\n\n// The toString() method means you can automatically cast the object to a string without any issues\n\"duration is \" + duration;\n// -\u003e duration is 1.5d\n\n// You can also specify to use a specific kind of units (metric or imperial, metric is default)\nconvert(3.5, \"km\").to(\"best\"); // -\u003e { quantity: 3.5, unit: 'km', toString: () =\u003e '3.5 km' }\nconvert(3.5, \"km\").to(\"best\", \"metric\"); // -\u003e { quantity: 3.5, unit: 'km', toString: () =\u003e '3.5 km' }\nconvert(3.5, \"km\").to(\"best\", \"imperial\"); // -\u003e { quantity: 2.17, unit: 'mi', toString: () =\u003e '3.5 mi' }\n```\n\n### `ms` shorthand\n\n```ts\nimport { ms } from \"convert\";\nconst { ms } = require(\"convert\");\n\n// Convert a duration into milliseconds\nms(\"1d 2h 30min\");\n// -\u003e 95400000\n\n// Convert milliseconds to a string\nms(86400000);\n// -\u003e '1d'\n```\n\n## Installation\n\n### Package manager\n\nConvert is published as `convert` on npm.\n\n```sh\nnpm install convert\n# or\nyarn add convert\n```\n\nAnd then import it in your code like this:\n\n```js\n// CommonJS\nconst { convert } = require(\"convert\");\n\n// ESM\nimport convert from \"convert\";\n```\n\n### Browsers\n\nPick your favorite CDN:\n\n#### ES Modules via CDN\n\n```html\n\u003cscript type=\"module\"\u003e\n\timport convert from \"https://cdn.skypack.dev/convert@5\";\n\timport convert from \"https://esm.run/convert@5\";\n\timport convert from \"https://cdn.jsdelivr.net/npm/convert@5\";\n\timport convert from \"https://unpkg.com/convert@5\";\n\u003c/script\u003e\n```\n\n#### UMD (global)\n\n```html\n\u003cscript src=\"https://cdn.jsdelivr.net/npm/convert@5/dist/index.js\"\u003e\u003c/script\u003e\n\u003cscript src=\"https://unpkg.com/convert@5/dist/index.js\"\u003e\u003c/script\u003e\n```\n\n## Alternatives\n\nConvert is better than other unit conversion libraries because it's faster and smaller than them, while having the same features.\nBenchmarks of popular unit conversion libraries, including Convert are [available here](https://github.com/jonahsnider/js-unit-conversion-benchmarks).\n\nConvert is the fastest, taking less than a microsecond for all functions.\nThat's a little over 3 million `convert()` calls per second.\n\n### Bundle size comparison\n\n[![npm bundle size of convert](https://img.shields.io/bundlephobia/minzip/convert?label=convert)](https://bundlephobia.com/result?p=convert)\n\n[![npm bundle size of safe-units](https://img.shields.io/bundlephobia/minzip/safe-units?label=safe-units)](https://bundlephobia.com/result?p=safe-units)\n\n[![npm bundle size of convert-units](https://img.shields.io/bundlephobia/minzip/convert-units?label=convert-units)](https://bundlephobia.com/result?p=convert-units)\n\n[![npm bundle size of js-quantities](https://img.shields.io/bundlephobia/minzip/js-quantities?label=js-quantities)](https://bundlephobia.com/result?p=js-quantities)\n\n[![npm bundle size of uom](https://img.shields.io/bundlephobia/minzip/uom?label=uom)](https://bundlephobia.com/result?p=uom)\n![+](https://img.shields.io/badge/%2B-gray)\n[![npm bundle size of uom-units](https://img.shields.io/bundlephobia/minzip/uom-units?label=uom-units)](https://bundlephobia.com/result?p=uom-units)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonahsnider%2Fconvert","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjonahsnider%2Fconvert","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonahsnider%2Fconvert/lists"}