UNPKG

version-int

Version:
47 lines (35 loc) 1.4 kB
# version-int parse a version string to int ## API * [version-int](#module_version-int) * [.parse(versionStr, [digitLength])](#module_version-int.parse) ⇒ <code>number</code> * [.setDigit([digitLength])](#module_version-int.setDigit) <a name="module_version-int.parse"></a> ### version-int.parse(versionStr, [digitLength]) ⇒ <code>number</code> parse a version string into a number **Kind**: static method of <code>[version-int](#module_version-int)</code> **Returns**: <code>number</code> - version number | Param | Type | Default | Description | | --- | --- | --- | --- | | versionStr | <code>string</code> | | version string | | [digitLength] | <code>number</code> | <code>3</code> | how long each sub-version is | **Example** ```js versionInt.parse('1.1.1'); // 1001001 versionInt.parse('1.1.1', 1); // 111 versionInt.parse('1.1.1', 2); // 10101 versionInt.parse('1.2.3456', 3); // 1001345 ``` <a name="module_version-int.setDigit"></a> ### version-int.setDigit([digitLength]) set/update default digitLength **Kind**: static method of <code>[version-int](#module_version-int)</code> | Param | Type | Default | Description | | --- | --- | --- | --- | | [digitLength] | <code>number</code> | <code>3</code> | how long each sub-version is | **Example** ```js versionInt.parse('1.1.1'); // 1001001 versionInt.setDigit(1); versionInt.parse('1.1.1'); // 111 ```