{"_id":"114k.js","_rev":"6-c2a6f11cad4a0adc9c42f2b71fa71eb7","name":"114k.js","dist-tags":{"latest":"0.1.3"},"versions":{"0.1.3":{"name":"114k.js","version":"0.1.3","keywords":["numbers","formatting","abbreviation","format"],"author":{"name":"anzai249"},"license":"MIT","_id":"114k.js@0.1.3","maintainers":[{"name":"anzai249","email":"a381811169@163.com"}],"homepage":"https://github.com/anzai249/114k.js#readme","bugs":{"url":"https://github.com/anzai249/114k.js/issues"},"dist":{"shasum":"ed26ac40eac42c223bd78f16acc7bc1170f05258","tarball":"https://registry.npmjs.org/114k.js/-/114k.js-0.1.3.tgz","fileCount":10,"integrity":"sha512-oUqQkZzuKBNE7gcKr841e/DpQrxQHSjPN0WYd7J7rUOhLBnJEk9Q7qxoM473wkLgox191O4jPNLNSJUKMu108w==","signatures":[{"sig":"MEQCIHGOQogVfsXYkdTfPd4lm8cZxmzEaCPx4j/toFs0phunAiAXqFqMj3uOY+33/Ws09eyyZmTca7ukjUVrxihtIHzczQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":11524},"main":"index.js","type":"module","_from":"file:114k.js-0.1.3.tgz","unpkg":"dist/format114k.global.js","module":"dist/format114k.esm-bundler.js","exports":{".":{"default":{"node":"./index.cjs","default":"./dist/format114k.esm-bundler.js","require":"./index.cjs"}}},"scripts":{"build":"rollup -c"},"_npmUser":{"name":"anzai249","email":"a381811169@163.com"},"jsdelivr":"dist/format114k.global.js","_resolved":"C:\\Users\\a3818\\AppData\\Local\\Temp\\1343f238e1ded75f9cc7aef56bdc246f\\114k.js-0.1.3.tgz","_integrity":"sha512-oUqQkZzuKBNE7gcKr841e/DpQrxQHSjPN0WYd7J7rUOhLBnJEk9Q7qxoM473wkLgox191O4jPNLNSJUKMu108w==","repository":{"url":"git+https://github.com/anzai249/114k.js.git","type":"git"},"_npmVersion":"10.8.2","description":"114k.js is a lightweight number abbreviation library.","directories":{},"_nodeVersion":"20.17.0","_hasShrinkwrap":false,"devDependencies":{"rollup":"^4.24.3","@rollup/plugin-json":"^6.1.0","rollup-plugin-terser":"^7.0.2"},"_npmOperationalInternal":{"tmp":"tmp/114k.js_0.1.3_1730472315545_0.7223589304132976","host":"s3://npm-registry-packages"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."}},"time":{"created":"2024-11-01T14:45:15.545Z","modified":"2025-09-11T00:29:17.363Z","0.1.0":"2024-10-31T12:43:16.415Z","0.1.1":"2024-10-31T12:57:33.800Z","0.1.2":"2024-10-31T13:01:16.285Z","0.1.3":"2024-11-01T14:45:15.768Z"},"bugs":{"url":"https://github.com/anzai249/114k.js/issues"},"author":{"name":"anzai249"},"license":"MIT","homepage":"https://github.com/anzai249/114k.js#readme","keywords":["numbers","formatting","abbreviation","format"],"repository":{"url":"git+https://github.com/anzai249/114k.js.git","type":"git"},"description":"114k.js is a lightweight number abbreviation library.","maintainers":[{"name":"anzai249","email":"a381811169@163.com"}],"readme":"# 114k.js\r\n\r\nA a lightweight number abbreviation library.\r\n\r\n## Get Started\r\n\r\n### Install\r\n\r\nUsing npm:\r\n\r\n```bash\r\nnpm i 114k.js\r\n```\r\n\r\nUsing `<script>`\r\n\r\n```html\r\n<script src=\"format114k.global.js\"></script>\r\n```\r\n\r\n### Usage\r\n\r\n```js\r\nimport { abbreviateNumber, formatNumber } from \"114k.js\"\r\n\r\nconsole.log(abbreviateNumber(114514)); // 114.5k\r\nconsole.log(formatNumber(114514)); // 114,514\r\n\r\n```\r\n\r\nor\r\n\r\n```js\r\nconsole.log(format114k.abbreviateNumber(114514)); // 114.5k\r\nconsole.log(format114k.formatNumber(114514)); // 114,514\r\n```\r\n\r\n## APIs\r\n\r\n### `formatNumber(num: Number): String`\r\n\r\nGet the formatted number like `114,514`\r\n\r\n#### Params\r\n\r\n##### `num: Number`\r\n\r\nThe number to be formatted.\r\n\r\n### `abbreviateNumber(num: Number, digits?: Number, rounding?: String, locale?: String): String`\r\n\r\n#### Params\r\n\r\n##### `num: Number`\r\n\r\nThe number to be abbreviated.\r\n\r\n##### `digits?: Number`\r\n\r\nNumber of decimal places to be retained. **An integer is required.**\r\n\r\nDefault: `1`\r\n\r\n##### `rounding?: String`\r\n\r\nRounding method.\r\n\r\nDefault: `\"round\"`\r\n\r\nPossible options:\r\n\r\n- `\"round\"`\r\n- `\"ceil\"`\r\n- `\"floor\"`\r\n\r\n##### `locale?: String`\r\n\r\nLanguage of the abbreviated number.\r\n\r\nDefault: `\"en\"`\r\n\r\nPossible options:\r\n\r\n- `\"en\"` // k, M, B, T...\r\n- `\"ru\"` // тыс., млн...\r\n- `\"zh-CN\"` // 万, 亿, 万亿...\r\n- `\"zh-TW\"` // 萬, 億, 兆, 京...\r\n- `\"ja\"` // 万, 億, 兆, 京...\r\n- `\"ko\"` // 만, 억, 조, 경...\r\n- `\"vi\"` // nghìn, tỷ, nghìn tỷ\r\n\r\nMaximum Numbers:\r\n\r\n- Maximum `num` of zh-CN, zh-TW, ja and ko is 1e25-1.\r\n- Maximum `num` of en and ru is 1e16-1.\r\n- Maximum `num` of vi is 1e13-1.\r\n\r\n## Examples\r\n\r\n```js\r\nconsole.log(\r\n    `The population of India in 2023 was ${formatNumber(1428627663)}, about ${abbreviateNumber(1428627663, 2, \"round\", \"en\")} people.`\r\n)\r\n// The population of India in 2023 was 1,428,627,663, about 1.43B people.\r\n```\r\n\r\n```js\r\nconsole.log(\r\n    `台灣共有${abbreviateNumber(36197, 2, \"round\", \"zh-TW\")}平方千米的土地。`\r\n)\r\n// 台灣共有3.62萬平方千米的土地。\r\n```\r\n\r\n```js\r\nconsole.log(\r\n    `中国大陆在约${abbreviateNumber(9596961, 2, \"round\", \"zh-CN\")}平方千米的土地中塞入了约${abbreviateNumber(1426389855, 2, \"round\", \"zh-CN\")}的人口。`\r\n)\r\n// 中国大陆在约959.7万平方千米的土地中塞入了约14.26亿的人口。\r\n```\r\n","readmeFilename":"README.md"}