Class Uuid25

The primary value type containing the Uuid25 representation of a UUID.

This class wraps a string value to provide conversion methods from/to other popular UUID textual representations.

Example

import { Uuid25 } from "uuid25";

// convert from/to string
const a = Uuid25.parse("8da942a4-1fbe-4ca6-852c-95c473229c7d");
console.assert(a.value === "8dx554y5rzerz1syhqsvsdw8t");
console.assert(a.toHyphenated() === "8da942a4-1fbe-4ca6-852c-95c473229c7d");

// convert from/to 128-bit byte array
const b = Uuid25.fromBytes(new Uint8Array(16).fill(0xff));
console.assert(b.value === "f5lxx1zz5pnorynqglhzmsp33");
console.assert(b.toBytes().every((x) => x === 0xff));

// convert from/to other popular textual representations
const c = [
  Uuid25.parse("e7a1d63b711744238988afcf12161878"),
  Uuid25.parse("e7a1d63b-7117-4423-8988-afcf12161878"),
  Uuid25.parse("{e7a1d63b-7117-4423-8988-afcf12161878}"),
  Uuid25.parse("urn:uuid:e7a1d63b-7117-4423-8988-afcf12161878"),
];
console.assert(c.every((x) => x.value === "dpoadk8izg9y4tte7vy1xt94o"));

const d = Uuid25.parse("dpoadk8izg9y4tte7vy1xt94o");
console.assert(d.toHex() === "e7a1d63b711744238988afcf12161878");
console.assert(d.toHyphenated() === "e7a1d63b-7117-4423-8988-afcf12161878");
console.assert(d.toBraced() === "{e7a1d63b-7117-4423-8988-afcf12161878}");
console.assert(d.toUrn() === "urn:uuid:e7a1d63b-7117-4423-8988-afcf12161878");

Conversion-from

fromBytes fromDigitValues parse parseBraced parseHex parseHexImpl parseHyphenated parseUrn parseUuid25

Conversion-to

toBraced toBytes toHex toHyphenated toUrn

Other

constructor value MAX [toPrimitive] equals toJSON toString valueOf

Conversion-from

Static fromBytes

  • fromBytes(uuidBytes): Uuid25

  • Creates an instance from a 16-byte UUID binary representation.

    Parameters

    • uuidBytes: Uint8Array

    Returns Uuid25

Static Private fromDigitValues

  • fromDigitValues(digitValues): Uuid25

  • Creates an instance from an array of Base36 digit values.

    Parameters

    • digitValues: Uint8Array

    Returns Uuid25

Static parse

  • parse(uuidString): Uuid25

  • Creates an instance from a UUID string representation.

    This method accepts the following formats:

    • 25-digit Base36 Uuid25 format: 3ud3gtvgolimgu9lah6aie99o
    • 32-digit hexadecimal format without hyphens: 40eb9860cf3e45e2a90eb82236ac806c
    • 8-4-4-4-12 hyphenated format: 40eb9860-cf3e-45e2-a90e-b82236ac806c
    • Hyphenated format with surrounding braces: {40eb9860-cf3e-45e2-a90e-b82236ac806c}
    • RFC 4122 URN format: urn:uuid:40eb9860-cf3e-45e2-a90e-b82236ac806c

    Parameters

    • uuidString: string

    Returns Uuid25

    Throws

    SyntaxError if the argument is not a valid UUID string.

Static parseBraced

  • parseBraced(uuidString): Uuid25

  • Creates an instance from the hyphenated format with surrounding braces: {40eb9860-cf3e-45e2-a90e-b82236ac806c}.

    Parameters

    • uuidString: string

    Returns Uuid25

    Throws

    SyntaxError if the argument is not in the specified format.

Static parseHex

  • parseHex(uuidString): Uuid25

  • Creates an instance from the 32-digit hexadecimal format without hyphens: 40eb9860cf3e45e2a90eb82236ac806c.

    Parameters

    • uuidString: string

    Returns Uuid25

    Throws

    SyntaxError if the argument is not in the specified format.

Static Private parseHexImpl

  • parseHexImpl(uuidString): Uuid25

  • Creates an instance from the hexadecimal representation without checking the syntax.

    Parameters

    • uuidString: undefined | string

    Returns Uuid25

    Throws

    SyntaxError if the argument is undefined.

Static parseHyphenated

  • parseHyphenated(uuidString): Uuid25

  • Creates an instance from the 8-4-4-4-12 hyphenated format: 40eb9860-cf3e-45e2-a90e-b82236ac806c.

    Parameters

    • uuidString: string

    Returns Uuid25

    Throws

    SyntaxError if the argument is not in the specified format.

Static parseUrn

  • parseUrn(uuidString): Uuid25

  • Creates an instance from the RFC 4122 URN format: urn:uuid:40eb9860-cf3e-45e2-a90e-b82236ac806c.

    Parameters

    • uuidString: string

    Returns Uuid25

    Throws

    SyntaxError if the argument is not in the specified format.

Static parseUuid25

  • parseUuid25(uuidString): Uuid25

  • Creates an instance from the 25-digit Base36 Uuid25 format: 3ud3gtvgolimgu9lah6aie99o.

    Parameters

    • uuidString: string

    Returns Uuid25

    Throws

    SyntaxError if the argument is not in the specified format.

Conversion-to

toBraced

  • toBraced(): string

  • Formats this in the hyphenated format with surrounding braces: {40eb9860-cf3e-45e2-a90e-b82236ac806c}.

    Returns string

toBytes

  • toBytes(): Uint8Array

  • Converts this into the 16-byte binary representation of a UUID.

    Returns Uint8Array

toHex

  • toHex(): string

  • Formats this in the 32-digit hexadecimal format without hyphens: 40eb9860cf3e45e2a90eb82236ac806c.

    Returns string

toHyphenated

  • toHyphenated(): string

  • Formats this in the 8-4-4-4-12 hyphenated format: 40eb9860-cf3e-45e2-a90e-b82236ac806c.

    Returns string

toUrn

  • toUrn(): string

  • Formats this in the RFC 4122 URN format: urn:uuid:40eb9860-cf3e-45e2-a90e-b82236ac806c.

    Returns string

Other

Private constructor

  • new Uuid25(value): Uuid25

  • Creates an instance from the inner string primitive.

    Parameters

    • value: string

      The underlying string value of the object in the 25-digit Base36 textual representation.

    Returns Uuid25

Readonly value

value: string

The underlying string value of the object in the 25-digit Base36 textual representation.

Static Private Readonly MAX

MAX: "f5lxx1zz5pnorynqglhzmsp33" = "f5lxx1zz5pnorynqglhzmsp33"

The maximum value of 128-bit unsigned integer (2^128 - 1) in the Base36 representation.

[toPrimitive]

  • [toPrimitive](_hint): string

  • Returns the underlying string value whenever the Object-to-primitive coercion occurs.

    Parameters

    • _hint: string

      Ignored.

    Returns string

equals

  • equals(other): boolean

  • Returns true if this.value equals to other.value.

    Parameters

    Returns boolean

toJSON

  • toJSON(): string

  • Serializes this as the underlying string primitive.

    Returns string

toString

  • toString(): string

  • Returns the underlying string value when converting this into a string.

    Returns string

valueOf

  • valueOf(): string

  • Returns the underlying string value whenever the Object-to-primitive coercion occurs.

    Returns string

Settings

Member Visibility

Theme

On This Page

fromBytesfromDigitValuesparseparseBracedparseHexparseHexImplparseHyphenatedparseUrnparseUuid25toBracedtoBytestoHextoHyphenatedtoUrnconstructorvalueMAX[toPrimitive]equalstoJSONtoStringvalueOf