number-helper-functions - npm Package Compare versions

Comparing version 2.1.1 to 3.0.0

package.json

 {
   "name": "number-helper-functions",
-  "version": "2.1.1",
+  "version": "3.0.0",
   "description": "Helper with multiple number-related methods",
-  "main": "index.js",
+  "main": "dist/index.js",
+  "module": "dist/number-helper-functions.esm.js",
+  "typings": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
   "author": "Alberto Rico",
@@ -10,17 +16,50 @@ "repository": {
   },
+  "engines": {
+    "node": ">=10"
+  },
   "license": "MIT",
   "devDependencies": {
+    "@size-limit/preset-small-lib": "^4.9.2",
+    "@typescript-eslint/eslint-plugin": "^4.15.2",
+    "@typescript-eslint/parser": "^4.15.2",
+    "babel-jest": "^26.6.3",
     "coveralls": "^3.1.0",
-    "eslint": "^5.4",
+    "eslint": "^7.20.0",
+    "eslint-config-prettier": "^8.1.0",
     "eslint-plugin-jest": "^23.9.0",
+    "husky": "^5.1.1",
     "jest": "^25.5.4",
-    "typescript": "^4.1.2"
+    "size-limit": "^4.9.2",
+    "tsdx": "^0.14.1",
+    "tslib": "^2.1.0",
+    "typedoc": "^0.20.28",
+    "typedoc-plugin-markdown": "^3.5.0",
+    "typescript": "^4.2.2"
   },
+  "size-limit": [
+    {
+      "path": "dist/number-helper-functions.cjs.production.min.js",
+      "limit": "10 KB"
+    },
+    {
+      "path": "dist/number-helper-functions.esm.js",
+      "limit": "10 KB"
+    }
+  ],
   "scripts": {
-    "test": "jest",
-    "typings": "tsc",
-    "prepublish": "yarn test && yarn run typings",
-    "coveralls": "jest --coverage && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js"
+    "start": "tsdx watch",
+    "build": "tsdx build",
+    "test": "tsdx test",
+    "lint": "tsdx lint",
+    "prepare": "tsdx build",
+    "size": "size-limit",
+    "analyze": "size-limit --why",
+    "docs": "typedoc src/index.ts --readme",
+    "coveralls": "tsdx test --coverage && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js"
   },
-  "types": "./index.d.ts"
+  "husky": {
+    "hooks": {
+      "pre-commit": "tsdx lint"
+    }
+  }
 }

README.md

@@ -1,172 +0,370 @@
-<a name="NumberHelper"></a>
+# number-helper-functions
 
-## NumberHelper
+## Table of contents
 
-**Kind**: global class
+### Type aliases
 
-- [NumberHelper](#NumberHelper)
-  - [new NumberHelper()](#new_NumberHelper_new)
-  - [.isNumber(n)](#NumberHelper.isNumber) ⇒ <code>boolean</code>
-  - [.isInt(n)](#NumberHelper.isInt) ⇒ <code>boolean</code>
-  - [.isFloat(n)](#NumberHelper.isFloat) ⇒ <code>boolean</code>
-  - [.isEven(n)](#NumberHelper.isEven) ⇒ <code>boolean</code>
-  - [.isOdd(n)](#NumberHelper.isOdd) ⇒ <code>boolean</code>
-  - [.isFinite(n)](#NumberHelper.isFinite) ⇒ <code>boolean</code>
-  - [.isPrime(num)](#NumberHelper.isPrime) ⇒ <code>boolean</code>
-  - [.getRandom(min, max)](#NumberHelper.getRandom) ⇒ <code>number</code>
-  - [.prefixWithZeros(number, length)](#NumberHelper.prefixWithZeros) ⇒ <code>string</code>
-  - [.convertToNumber(toCheck, [decimals])](#NumberHelper.convertToNumber) ⇒ <code>number</code>
-  - [.processNumber(value, [decimals])](#NumberHelper.processNumber) ⇒ <code>number</code>
+- [NumberLik#numberlike)
 
-<a name="new_NumberHelper_new"></a>
+## Type aliases
 
-### new NumberHelper()
+### NumberLike
 
-NumberHelper Class
+Ƭ **NumberLike**: _string_ \| _number_ \| _null_ \| _undefined_
 
-<a name="NumberHelper.isNumber"></a>
+Defined in: index.ts:1
 
-### NumberHelper.isNumber(n) ⇒ <code>boolean</code>
+# Class: default
 
-Checks if element is a number
+NumberHelper class
 
-**Kind**: static method of [<code>NumberHelper</code>](#NumberHelper)  
-**Returns**: <code>boolean</code> - Whether the element is a number or not
+**`export`**
 
-| Param | Type                                       | Description          |
-| ----- | ------------------------------------------ | -------------------- |
-| n     | <code>string</code> \| <code>number</code> | The element to check |
+## Table of contents
 
-<a name="NumberHelper.isInt"></a>
+### Constructors
 
-### NumberHelper.isInt(n) ⇒ <code>boolean</code>
+- [constructor](#constructor)
 
-Checks if element is an integer
+### Methods
 
-**Kind**: static method of [<code>NumberHelper</code>](#NumberHelper)  
-**Returns**: <code>boolean</code> - Whether the number is an integer or not
+- [checkDecimals](#checkdecimals)
+- [convertToNumber](#converttonumber)
+- [enforceNumber](#enforcenumber)
+- [getRandom](#getrandom)
+- [isEven](#iseven)
+- [isFinite](#isfinite)
+- [isFloat](#isfloat)
+- [isInt](#isint)
+- [isNumber](#isnumber)
+- [isOdd](#isodd)
+- [isPrime](#isprime)
+- [prefixWithZeros](#prefixwithzeros)
+- [processNumber](#processnumber)
 
-| Param | Type                                       | Description     |
-| ----- | ------------------------------------------ | --------------- |
-| n     | <code>string</code> \| <code>number</code> | Number to check |
+## Constructors
 
-<a name="NumberHelper.isFloat"></a>
+### constructor
 
-### NumberHelper.isFloat(n) ⇒ <code>boolean</code>
+\+ **new default**(): [_default_]()
 
-Checks if element is a float number
+**Returns:** [_default_]()
 
-**Kind**: static method of [<code>NumberHelper</code>](#NumberHelper)  
-**Returns**: <code>boolean</code> - Whether the number is a float or not
+## Methods
 
-| Param | Type                                       | Description     |
-| ----- | ------------------------------------------ | --------------- |
-| n     | <code>string</code> \| <code>number</code> | Number to check |
+### checkDecimals
 
-<a name="NumberHelper.isEven"></a>
+▸ `Static`**checkDecimals**(`number`: [_NumberLike_](#numberlike)): _number_
 
-### NumberHelper.isEven(n) ⇒ <code>boolean</code>
+Checks the decimals of a number
 
+**`static`**
+
+**`memberof`** NumberHelper
+
+#### Parameters:
+
+| Name     | Type                        | Description                               |
+| :------- | :-------------------------- | :---------------------------------------- |
+| `number` | [_NumberLike_](#numberlike) | Number to check the amount of decimals of |
+
+**Returns:** _number_
+
+The number of decimals
+
+Defined in: index.ts:146
+
+---
+
+### convertToNumber
+
+▸ `Static`**convertToNumber**(`toCheck`: [_NumberLike_](#numberlike), `decimals?`: _number_): _number_
+
+Converts string to number
+
+**`static`**
+
+**`memberof`** NumberHelper
+
+#### Parameters:
+
+| Name       | Type                        | Default value | Description            |
+| :--------- | :-------------------------- | :------------ | :--------------------- |
+| `toCheck`  | [_NumberLike_](#numberlike) | -             | Number-like to convert |
+| `decimals` | _number_                    | 2             | -                      |
+
+**Returns:** _number_
+
+Converted number
+
+Defined in: index.ts:165
+
+---
+
+### enforceNumber
+
+▸ `Private` `Static`**enforceNumber**(`n`: [_NumberLike_](#numberlike)): _number_
+
+Converts to number
+
+**`static`**
+
+**`memberof`** NumberHelper
+
+#### Parameters:
+
+| Name | Type                        | Description                           |
+| :--- | :-------------------------- | :------------------------------------ |
+| `n`  | [_NumberLike_](#numberlike) | Number or string to convert to number |
+
+**Returns:** _number_
+
+The resulting number
+
+Defined in: index.ts:196
+
+---
+
+### getRandom
+
+▸ `Static`**getRandom**(`min`: _number_, `max`: _number_): _number_
+
+Gets random integer number in a range
+
+**`static`**
+
+**`memberof`** NumberHelper
+
+#### Parameters:
+
+| Name  | Type     | Description    |
+| :---- | :------- | :------------- |
+| `min` | _number_ | Minimum number |
+| `max` | _number_ | Maximum number |
+
+**Returns:** _number_
+
+Random number in range
+
+Defined in: index.ts:122
+
+---
+
+### isEven
+
+▸ `Static`**isEven**(`n`: [_NumberLike_](#numberlike)): _boolean_
+
 Checks if number is even
+Any integer that can be divided exactly by 2 is an even number
 
-**Kind**: static method of [<code>NumberHelper</code>](#NumberHelper)  
-**Returns**: <code>boolean</code> - Whether the number is even or not
+**`static`**
 
-| Param | Type                | Description     |
-| ----- | ------------------- | --------------- |
-| n     | <code>number</code> | Number to check |
+**`memberof`** NumberHelper
 
-<a name="NumberHelper.isOdd"></a>
+#### Parameters:
 
-### NumberHelper.isOdd(n) ⇒ <code>boolean</code>
+| Name | Type                        | Description     |
+| :--- | :-------------------------- | :-------------- |
+| `n`  | [_NumberLike_](#numberlike) | Number to check |
 
-Checks if number is odd
+**Returns:** _boolean_
 
-**Kind**: static method of [<code>NumberHelper</code>](#NumberHelper)  
-**Returns**: <code>boolean</code> - Whether the number is odd or not
+Whether the number is even or not
 
-| Param | Type                | Description     |
-| ----- | ------------------- | --------------- |
-| n     | <code>number</code> | Number to check |
+Defined in: index.ts:64
 
-<a name="NumberHelper.isFinite"></a>
+---
 
-### NumberHelper.isFinite(n) ⇒ <code>boolean</code>
+### isFinite
 
+▸ `Static`**isFinite**(`n`: [_NumberLike_](#numberlike)): _boolean_
+
 Checks if numer is finite
 
-**Kind**: static method of [<code>NumberHelper</code>](#NumberHelper)  
-**Returns**: <code>boolean</code> - Whether the number is finite or not
+**`static`**
 
-| Param | Type                | Description     |
-| ----- | ------------------- | --------------- |
-| n     | <code>number</code> | Number to check |
+**`memberof`** NumberHelper
 
-<a name="NumberHelper.isPrime"></a>
+#### Parameters:
 
-### NumberHelper.isPrime(num) ⇒ <code>boolean</code>
+| Name | Type                        | Description     |
+| :--- | :-------------------------- | :-------------- |
+| `n`  | [_NumberLike_](#numberlike) | Number to check |
 
+**Returns:** _boolean_
+
+Whether the number is finite or not
+
+Defined in: index.ts:89
+
+---
+
+### isFloat
+
+▸ `Static`**isFloat**(`n`: [_NumberLike_](#numberlike)): _boolean_
+
+Checks if element is a float number
+
+**`static`**
+
+**`memberof`** NumberHelper
+
+#### Parameters:
+
+| Name | Type                        | Description     |
+| :--- | :-------------------------- | :-------------- |
+| `n`  | [_NumberLike_](#numberlike) | Number to check |
+
+**Returns:** _boolean_
+
+Whether the number is a float or not
+
+Defined in: index.ts:47
+
+---
+
+### isInt
+
+▸ `Static`**isInt**(`n`: [_NumberLike_](#numberlike)): _boolean_
+
+Checks if element is an integer
+
+**`static`**
+
+**`memberof`** NumberHelper
+
+#### Parameters:
+
+| Name | Type                        | Description     |
+| :--- | :-------------------------- | :-------------- |
+| `n`  | [_NumberLike_](#numberlike) | Number to check |
+
+**Returns:** _boolean_
+
+Whether the number is an integer or not
+
+Defined in: index.ts:31
+
+---
+
+### isNumber
+
+▸ `Static`**isNumber**(`n`: [_NumberLike_](#numberlike)): _boolean_
+
+Checks if element is a number
+
+**`static`**
+
+**`memberof`** NumberHelper
+
+#### Parameters:
+
+| Name | Type                        | Description          |
+| :--- | :-------------------------- | :------------------- |
+| `n`  | [_NumberLike_](#numberlike) | The element to check |
+
+**Returns:** _boolean_
+
+Whether the element is a number or not
+
+Defined in: index.ts:19
+
+---
+
+### isOdd
+
+▸ `Static`**isOdd**(`n`: [_NumberLike_](#numberlike)): _boolean_
+
+Checks if number is odd
+Any integer that cannot be divided exactly by 2 is an odd number.
+
+**`static`**
+
+**`memberof`** NumberHelper
+
+#### Parameters:
+
+| Name | Type                        | Description     |
+| :--- | :-------------------------- | :-------------- |
+| `n`  | [_NumberLike_](#numberlike) | Number to check |
+
+**Returns:** _boolean_
+
+Whether the number is odd or not
+
+Defined in: index.ts:77
+
+---
+
+### isPrime
+
+▸ `Static`**isPrime**(`num`: _number_): _boolean_
+
 Checks if number is prime
+Natural number greater than 1 that cannot be formed by multiplying two smaller natural numbers
 
-**Kind**: static method of [<code>NumberHelper</code>](#NumberHelper)  
-**Returns**: <code>boolean</code> - Whether the numbere is prime or not
+**`static`**
 
-| Param | Type                | Description     |
-| ----- | ------------------- | --------------- |
-| num   | <code>number</code> | Number to check |
+**`memberof`** NumberHelper
 
-<a name="NumberHelper.getRandom"></a>
+#### Parameters:
 
-### NumberHelper.getRandom(min, max) ⇒ <code>number</code>
+| Name  | Type     | Description     |
+| :---- | :------- | :-------------- |
+| `num` | _number_ | Number to check |
 
-Gets random integer number in a range
+**Returns:** _boolean_
 
-**Kind**: static method of [<code>NumberHelper</code>](#NumberHelper)  
-**Returns**: <code>number</code> - Random number in range
+Whether the numbere is prime or not
 
-| Param | Type                | Description    |
-| ----- | ------------------- | -------------- |
-| min   | <code>number</code> | Minimum number |
-| max   | <code>number</code> | Maximum number |
+Defined in: index.ts:102
 
-<a name="NumberHelper.prefixWithZeros"></a>
+---
 
-### NumberHelper.prefixWithZeros(number, length) ⇒ <code>string</code>
+### prefixWithZeros
 
+▸ `Static`**prefixWithZeros**(`number`: _number_, `length`: _number_): _string_
+
 Prefixes a number with zeros until desired length
 
-**Kind**: static method of [<code>NumberHelper</code>](#NumberHelper)  
-**Returns**: <code>string</code> - Padded number as a string
+**`static`**
 
-| Param  | Type                | Description           |
-| ------ | ------------------- | --------------------- |
-| number | <code>number</code> | Number to pad         |
-| length | <code>number</code> | Desired number length |
+**`memberof`** NumberHelper
 
-<a name="NumberHelper.convertToNumber"></a>
+#### Parameters:
 
-### NumberHelper.convertToNumber(toCheck, [decimals]) ⇒ <code>number</code>
+| Name     | Type     | Description           |
+| :------- | :------- | :-------------------- |
+| `number` | _number_ | Number to pad         |
+| `length` | _number_ | Desired number length |
 
-Converts string to number
+**Returns:** _string_
 
-**Kind**: static method of [<code>NumberHelper</code>](#NumberHelper)  
-**Returns**: <code>number</code> - Converted number
+Padded number as a string
 
-| Param      | Type                                       | Default        | Description                    |
-| ---------- | ------------------------------------------ | -------------- | ------------------------------ |
-| toCheck    | <code>string</code> \| <code>number</code> |                | Number-like to convert         |
-| [decimals] | <code>number</code>                        | <code>2</code> | Number of decimals to truncate |
+Defined in: index.ts:135
 
-<a name="NumberHelper.processNumber"></a>
+---
 
-### NumberHelper.processNumber(value, [decimals]) ⇒ <code>number</code>
+### processNumber
 
+▸ `Static`**processNumber**(`value`: [_NumberLike_](#numberlike), `decimals?`: _number_): _number_
+
 Processes number to get clean value
 
-**Kind**: static method of [<code>NumberHelper</code>](#NumberHelper)  
-**Returns**: <code>number</code> - Parsed and processed number
+**`static`**
 
-| Param      | Type                                       | Default        | Description                    |
-| ---------- | ------------------------------------------ | -------------- | ------------------------------ |
-| value      | <code>string</code> \| <code>number</code> |                | String or number to process    |
-| [decimals] | <code>number</code>                        | <code>2</code> | No. of decimals to truncate to |
+**`memberof`** NumberHelper
+
+#### Parameters:
+
+| Name       | Type                        | Default value | Description                 |
+| :--------- | :-------------------------- | :------------ | :-------------------------- |
+| `value`    | [_NumberLike_](#numberlike) | -             | String or number to process |
+| `decimals` | _number_                    | 2             | -                           |
+
+**Returns:** _number_
+
+Parsed and processed number
+
+Defined in: index.ts:184

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

58123

increased by105.11%

Number of package files

13

increased by30%

Lines of code

749

increased by12.46%

Number of lines in readme file

371

increased by114.45%

Worsened metrics

Dev dependency count

16

increased by220%

Number of low supply chain risk alerts

2

increased by100%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes