commafy-anything 3.0.2 → 3.0.3

package/README.md

@@ -7,21 +7,26 @@
 npm i commafy-anything
 ```
 
-Adds comma's to a number. A simple and small integration.
+Return a number as string with `,` or `K`. A simple and small integration.
 
 ## Motivation
 
-U built this package because I needed to add comma's to numbers! And I wanted to build it myself. 😄
+U built this package because I needed to add comma's and K to numbers! And I wanted to build it myself. 😄
 
-## Meet the family
+## Meet the family (more tiny utils with TS support)
 
-- [copy-anything 🎭](https://github.com/mesqueeb/copy-anything)
+- [is-what 🙉](https://github.com/mesqueeb/is-what)
+- [is-where 🙈](https://github.com/mesqueeb/is-where)
 - [merge-anything 🥡](https://github.com/mesqueeb/merge-anything)
+- [check-anything 👁](https://github.com/mesqueeb/check-anything)
+- [remove-anything ✂️](https://github.com/mesqueeb/remove-anything)
+- [getorset-anything 🐊](https://github.com/mesqueeb/getorset-anything)
+- [map-anything 🗺](https://github.com/mesqueeb/map-anything)
 - [filter-anything ⚔️](https://github.com/mesqueeb/filter-anything)
-- [find-and-replace-anything 🎣](https://github.com/mesqueeb/find-and-replace-anything)
-- [compare-anything 🛰](https://github.com/mesqueeb/compare-anything)
+- [copy-anything 🎭](https://github.com/mesqueeb/copy-anything)
+- [case-anything 🐫](https://github.com/mesqueeb/case-anything)
 - [flatten-anything 🏏](https://github.com/mesqueeb/flatten-anything)
-- [is-what 🙉](https://github.com/mesqueeb/is-what)
+- [nestify-anything 🧅](https://github.com/mesqueeb/nestify-anything)
 
 ## Usage
 
@@ -35,20 +40,47 @@ commafy(1000000) === '1,000,000'
 // etc.
 ```
 
+### K
+
+You can show numbers as 1K.
+
+```js
+const options = { K: true }
+// when smaller than 1000 will be shown as is, without K
+commafy(123, options) === '123'
+
+// when larger than 1000 it will round up/down behind the K
+commafy(1234, options) === '1K'
+commafy(10234, options) === '10K'
+commafy(100234, options) === '100K'
+commafy(1000234, options) === '1,000K'
+
+commafy(1955, options) === '2K'
+commafy(10955, options) === '11K'
+commafy(100955, options) === '101K'
+commafy(1000955, options) === '1,001K'
+```
+
 ### Thousands
 
+You can disable a comma to be added when the number is between `1000` ~ `9999`.
+
 ```js
 // default:
 commafy(1000) === '1,000'
 
-// thousands:
-const options = {thousandsComma: false}
+const options = { thousandsComma: false }
 commafy(1000, options) === '1000'
+commafy(9999, options) === '9999'
+
+// beyond 9999 it will always have a comma
 commafy(10000, options) === '10,000'
 ```
 
 ### Spaced decimals
 
+You can add spaces to decimals.
+
 ```js
 // default:
 commafy(1.0001) === '1.0001'
@@ -57,7 +89,7 @@ commafy(1.000001) === '1.000001'
 commafy(1.0000001) === '1.0000001'
 
 // spaced decimals:
-const options = {spacedDecimals: true}
+const options = { spacedDecimals: true }
 commafy(1.0001, options) === '1.0001'
 commafy(1.00001, options) === '1.000 01'
 commafy(1.000001, options) === '1.000 001'
@@ -66,12 +98,14 @@ commafy(1.0000001, options) === '1.000 0001'
 
 ### Strip decimals
 
+You can add strip away decimals.
+
 ```js
 // default:
 commafy(1.0001) === '1.0001'
 
 // strip decimals:
-const options = {stripDecimals: true}
+const options = { stripDecimals: true }
 commafy(1.001, options) === '1'
 commafy(1.999, options) === '1'
 ```
@@ -81,7 +115,7 @@ commafy(1.999, options) === '1'
 I'm using simple regular expressions. The source code is in TypeScript, but the essense of my source code looks something like this:
 
 ```js
-function commafy (num, {stripDecimals, spacedDecimals} = {}) {
+function commafy(num, { stripDecimals, spacedDecimals } = {}) {
   const str = num.toString().split('.')
   if (str[0].length >= 4) {
     str[0] = str[0].replace(/(\d)(?=(\d{3})+$)/g, '$1,')

package/dist/index.cjs

@@ -1,7 +1,5 @@
 'use strict';
 
-Object.defineProperty(exports, '__esModule', { value: true });
-
 /**
  * Adds comma's to a number
  *

package/package.json

@@ -2,16 +2,16 @@
   "name": "commafy-anything",
   "sideEffects": false,
   "type": "module",
-  "version": "3.0.2",
+  "version": "3.0.3",
   "description": "Adds comma's to a number. A simple and small integration",
   "module": "./dist/index.es.js",
   "main": "./dist/index.cjs",
   "types": "./dist/types/index.d.ts",
   "exports": {
     ".": {
+      "types": "./dist/types/index.d.ts",
       "import": "./dist/index.es.js",
-      "require": "./dist/index.cjs",
-      "types": "./dist/types/index.d.ts"
+      "require": "./dist/index.cjs"
     }
   },
   "files": [
@@ -23,7 +23,7 @@
   "scripts": {
     "test": "vitest run",
     "lint": "tsc --noEmit && eslint ./src --ext .ts",
-    "build": "rollup -c ./scripts/build.js",
+    "build": "rollup --bundleConfigAsCjs -c ./scripts/build.js",
     "release": "npm run lint && del dist && npm run build && np"
   },
   "repository": {
@@ -44,18 +44,18 @@
   },
   "homepage": "https://github.com/mesqueeb/commafy-anything#readme",
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^5.10.1",
-    "@typescript-eslint/parser": "^5.10.1",
+    "@typescript-eslint/eslint-plugin": "^5.59.2",
+    "@typescript-eslint/parser": "^5.59.2",
     "del-cli": "^4.0.1",
-    "eslint": "^8.7.0",
-    "eslint-config-prettier": "^8.3.0",
+    "eslint": "^8.40.0",
+    "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-tree-shaking": "^1.10.0",
-    "np": "^7.6.0",
-    "prettier": "^2.5.1",
-    "rollup": "^2.66.1",
-    "rollup-plugin-typescript2": "^0.31.1",
-    "typescript": "^4.5.5",
-    "vitest": "^0.2.3"
+    "np": "^7.7.0",
+    "prettier": "^2.8.8",
+    "rollup": "^3.21.5",
+    "rollup-plugin-typescript2": "^0.34.1",
+    "typescript": "^4.9.5",
+    "vitest": "^0.31.0"
   },
   "np": {
     "yarn": false,