Comparing version 5.0.0 to 5.0.1
@@ -5,3 +5,3 @@ /** | ||
* @author LiosK | ||
* @version v5.0.0 | ||
* @version v5.0.1 | ||
* @license Apache License 2.0: Copyright (c) 2010-2023 LiosK | ||
@@ -11,3 +11,3 @@ * @packageDocumentation | ||
/** | ||
* UUID object. | ||
* The UUID object type. | ||
*/ | ||
@@ -17,9 +17,9 @@ export declare class UUID { | ||
* Generates a version 4 UUID as a hexadecimal string. | ||
* @returns Hexadecimal UUID string. | ||
* @returns The hexadecimal UUID string. | ||
*/ | ||
static generate(): string; | ||
/** | ||
* Returns an unsigned x-bit random integer. | ||
* @param x - Unsigned integer ranging from 0 to 53, inclusive. | ||
* @returns Unsigned x-bit random integer (0 <= f(x) < 2^x). | ||
* Returns an unsigned `x`-bit random integer. | ||
* @param x - An unsigned integer ranging from 0 to 53, inclusive. | ||
* @returns An unsigned `x`-bit random integer (`0 <= f(x) < 2^x`). | ||
*/ | ||
@@ -39,3 +39,3 @@ private static _getRandomInt; | ||
/** | ||
* Names of UUID internal fields. | ||
* The names of UUID internal fields. | ||
* @since 3.0 | ||
@@ -45,3 +45,3 @@ */ | ||
/** | ||
* Sizes of UUID internal fields. | ||
* The sizes of UUID internal fields. | ||
* @since 3.0 | ||
@@ -52,3 +52,3 @@ */ | ||
* Creates a version 4 UUID object. | ||
* @returns Version 4 UUID object. | ||
* @returns A version 4 UUID object. | ||
* @since 3.0 | ||
@@ -59,4 +59,4 @@ */ | ||
* Converts a hexadecimal UUID string to a UUID object. | ||
* @param strId - Hexadecimal UUID string ("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"). | ||
* @returns UUID object or null. | ||
* @param strId - A hexadecimal UUID string ("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"). | ||
* @returns The UUID object or `null`. | ||
* @since 3.0 | ||
@@ -66,3 +66,3 @@ */ | ||
/** | ||
* UUID internal field values as an array of integers. | ||
* The UUID internal field values as an array of integers. | ||
*/ | ||
@@ -78,3 +78,3 @@ readonly intFields: readonly number[] & { | ||
/** | ||
* UUID internal field values as an array of binary strings. | ||
* The UUID internal field values as an array of binary strings. | ||
*/ | ||
@@ -90,3 +90,3 @@ readonly bitFields: readonly string[] & { | ||
/** | ||
* UUID internal field values as an array of hexadecimal strings. | ||
* The UUID internal field values as an array of hexadecimal strings. | ||
*/ | ||
@@ -102,11 +102,11 @@ readonly hexFields: readonly string[] & { | ||
/** | ||
* UUID version number. | ||
* The UUID version number. | ||
*/ | ||
readonly version: number; | ||
/** | ||
* 128-bit binary string representation. | ||
* The 128-bit binary string representation. | ||
*/ | ||
readonly bitString: string; | ||
/** | ||
* Non-delimited hexadecimal string representation ("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"). | ||
* The non-delimited hexadecimal string representation ("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"). | ||
* @since v3.3.0 | ||
@@ -116,7 +116,7 @@ */ | ||
/** | ||
* Hexadecimal string representation ("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"). | ||
* The hexadecimal string representation ("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"). | ||
*/ | ||
readonly hexString: string; | ||
/** | ||
* URN string representation ("urn:uuid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"). | ||
* The URN string representation ("urn:uuid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"). | ||
*/ | ||
@@ -126,8 +126,8 @@ readonly urn: string; | ||
* Initializes the UUID object. | ||
* @param _timeLow - time_low field (octet 0-3, uint32). | ||
* @param _timeMid - time_mid field (octet 4-5, uint16). | ||
* @param _timeHiAndVersion - time_hi_and_version field (octet 6-7, uint16). | ||
* @param _clockSeqHiAndReserved - clock_seq_hi_and_reserved field (octet 8, uint8). | ||
* @param _clockSeqLow - clock_seq_low field (octet 9, uint8). | ||
* @param _node - node field (octet 10-15, uint48). | ||
* @param _timeLow - The time_low field (octet 0-3, uint32). | ||
* @param _timeMid - The time_mid field (octet 4-5, uint16). | ||
* @param _timeHiAndVersion - The time_hi_and_version field (octet 6-7, uint16). | ||
* @param _clockSeqHiAndReserved - The clock_seq_hi_and_reserved field (octet 8, uint8). | ||
* @param _clockSeqLow - The clock_seq_low field (octet 9, uint8). | ||
* @param _node - The node field (octet 10-15, uint48). | ||
*/ | ||
@@ -146,7 +146,7 @@ private constructor(); | ||
* Tests if two UUID objects are equal. | ||
* @returns True if two UUID objects are equal. | ||
* @returns `true` if two UUID objects are equal. | ||
*/ | ||
equals(uuid: UUID): boolean; | ||
/** | ||
* Nil UUID object. | ||
* A nil UUID object. | ||
* @since v3.4.0 | ||
@@ -157,3 +157,3 @@ */ | ||
* Creates a version 1 UUID object. | ||
* @returns Version 1 UUID object. | ||
* @returns A version 1 UUID object. | ||
* @since 3.0 | ||
@@ -168,7 +168,7 @@ */ | ||
/** | ||
* Persistent internal state for version 1 UUID creation. | ||
* The persistent internal state for version 1 UUID creation. | ||
*/ | ||
private static _state; | ||
/** | ||
* @param time - Milliseconds elapsed since 1970-01-01. | ||
* @param time - The number of milliseconds elapsed since 1970-01-01. | ||
*/ | ||
@@ -180,3 +180,3 @@ private static _getTimeFieldValues; | ||
* conforming to semantic versioning requirements. | ||
* @returns Version 6 UUID object. | ||
* @returns A version 6 UUID object. | ||
* @since v4.2.13 | ||
@@ -183,0 +183,0 @@ * @experimental |
@@ -5,3 +5,3 @@ /** | ||
* @author LiosK | ||
* @version v5.0.0 | ||
* @version v5.0.1 | ||
* @license Apache License 2.0: Copyright (c) 2010-2023 LiosK | ||
@@ -12,9 +12,9 @@ * @packageDocumentation | ||
/** | ||
* UUID object. | ||
* The UUID object type. | ||
*/ | ||
export class UUID { | ||
class UUID { | ||
// Core Component {{{ | ||
/** | ||
* Generates a version 4 UUID as a hexadecimal string. | ||
* @returns Hexadecimal UUID string. | ||
* @returns The hexadecimal UUID string. | ||
*/ | ||
@@ -35,5 +35,5 @@ static generate() { | ||
/** | ||
* Returns an unsigned x-bit random integer. | ||
* @param x - Unsigned integer ranging from 0 to 53, inclusive. | ||
* @returns Unsigned x-bit random integer (0 <= f(x) < 2^x). | ||
* Returns an unsigned `x`-bit random integer. | ||
* @param x - An unsigned integer ranging from 0 to 53, inclusive. | ||
* @returns An unsigned `x`-bit random integer (`0 <= f(x) < 2^x`). | ||
*/ | ||
@@ -71,3 +71,3 @@ static _getRandomInt(x) { | ||
* Creates a version 4 UUID object. | ||
* @returns Version 4 UUID object. | ||
* @returns A version 4 UUID object. | ||
* @since 3.0 | ||
@@ -87,4 +87,4 @@ */ | ||
* Converts a hexadecimal UUID string to a UUID object. | ||
* @param strId - Hexadecimal UUID string ("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"). | ||
* @returns UUID object or null. | ||
* @param strId - A hexadecimal UUID string ("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"). | ||
* @returns The UUID object or `null`. | ||
* @since 3.0 | ||
@@ -106,8 +106,8 @@ */ | ||
* Initializes the UUID object. | ||
* @param _timeLow - time_low field (octet 0-3, uint32). | ||
* @param _timeMid - time_mid field (octet 4-5, uint16). | ||
* @param _timeHiAndVersion - time_hi_and_version field (octet 6-7, uint16). | ||
* @param _clockSeqHiAndReserved - clock_seq_hi_and_reserved field (octet 8, uint8). | ||
* @param _clockSeqLow - clock_seq_low field (octet 9, uint8). | ||
* @param _node - node field (octet 10-15, uint48). | ||
* @param _timeLow - The time_low field (octet 0-3, uint32). | ||
* @param _timeMid - The time_mid field (octet 4-5, uint16). | ||
* @param _timeHiAndVersion - The time_hi_and_version field (octet 6-7, uint16). | ||
* @param _clockSeqHiAndReserved - The clock_seq_hi_and_reserved field (octet 8, uint8). | ||
* @param _clockSeqLow - The clock_seq_low field (octet 9, uint8). | ||
* @param _node - The node field (octet 10-15, uint48). | ||
*/ | ||
@@ -169,3 +169,3 @@ constructor(_timeLow, _timeMid, _timeHiAndVersion, _clockSeqHiAndReserved, _clockSeqLow, _node) { | ||
* Tests if two UUID objects are equal. | ||
* @returns True if two UUID objects are equal. | ||
* @returns `true` if two UUID objects are equal. | ||
*/ | ||
@@ -187,3 +187,3 @@ equals(uuid) { | ||
* Creates a version 1 UUID object. | ||
* @returns Version 1 UUID object. | ||
* @returns A version 1 UUID object. | ||
* @since 3.0 | ||
@@ -229,3 +229,3 @@ */ | ||
/** | ||
* @param time - Milliseconds elapsed since 1970-01-01. | ||
* @param time - The number of milliseconds elapsed since 1970-01-01. | ||
*/ | ||
@@ -248,3 +248,3 @@ static _getTimeFieldValues(time) { | ||
* conforming to semantic versioning requirements. | ||
* @returns Version 6 UUID object. | ||
* @returns A version 6 UUID object. | ||
* @since v4.2.13 | ||
@@ -308,3 +308,3 @@ * @experimental | ||
/** | ||
* Names of UUID internal fields. | ||
* The names of UUID internal fields. | ||
* @since 3.0 | ||
@@ -321,3 +321,3 @@ */ | ||
/** | ||
* Sizes of UUID internal fields. | ||
* The sizes of UUID internal fields. | ||
* @since 3.0 | ||
@@ -327,3 +327,3 @@ */ | ||
/** | ||
* Nil UUID object. | ||
* A nil UUID object. | ||
* @since v3.4.0 | ||
@@ -333,5 +333,6 @@ */ | ||
/** | ||
* Persistent internal state for version 1 UUID creation. | ||
* The persistent internal state for version 1 UUID creation. | ||
*/ | ||
UUID._state = null; | ||
export { UUID }; | ||
// UUID Version 1 Component (2 of 2) {{{ | ||
@@ -338,0 +339,0 @@ class UUIDState { |
{ | ||
"name": "uuidjs", | ||
"version": "5.0.0", | ||
"version": "5.0.1", | ||
"title": "UUID.js", | ||
@@ -14,2 +14,3 @@ "description": "RFC-compliant UUID Generator for JavaScript", | ||
"files": [ | ||
"CHANGELOG.md", | ||
"dist", | ||
@@ -49,5 +50,5 @@ "example.js" | ||
"qunit": "^2.19.4", | ||
"typedoc": "^0.23.24", | ||
"typescript": "^4.9.4" | ||
"typedoc": "^0.23.28", | ||
"typescript": "^5.0.2" | ||
} | ||
} |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
AI-detected possible typosquat
Supply chain riskAI has identified this package as a potential typosquat of a more popular package. This suggests that the package may be intentionally mimicking another package's name, description, or other metadata.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage 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
36802
9
522