Class Guid

Represents a globally unique identifier. Performs RAII to make sure that the GUID is valid and all subsequent assignments are valid.

The class standardises GUIDs by stripping square and squiggly brackets and converting to lowercase.

Hierarchy

CheckedString
- Guid
  - Null

Implements

IMutable

Index

Constructors

constructor

Properties

regex

Accessors

value

Methods

Constructors

constructor

new Guid(value: Accepted, __namedParameters?: object): Guid

Overrides CheckedString.constructor
- Defined in Guid.ts:213
Parameters
- value: Accepted
- Default value __namedParameters: object = {}
  - endianness: undefined | Big | Com | Little
  - options: options
Returns Guid

Properties

regex

regex: RegExp

Accessors

value

get value(): string
set value(value: string): void

Inherited from String.value
- Defined in String.ts:42
Returns string
Inherited from String.value
- Defined in String.ts:46
Parameters
- value: string
Returns void

Methods

__@iterator

__@iterator(): IterableIterator<string>

Implementation of IMutable.__@iterator

Inherited from String.__@iterator
- Defined in String.ts:70
Iterates of the characters in the string

Returns IterableIterator<string>

__@toPrimitive

__@toPrimitive(hint: "string" | "number" | "default"): string | number

Implementation of IMutable.__@toPrimitive

Inherited from String.__@toPrimitive
- Defined in String.ts:53
Converts the object into a primitive

Parameters
- hint: "string" | "number" | "default"
Returns string | number

__@toStringTag

__@toStringTag(): string

Implementation of IMutable.__@toStringTag

Inherited from String.__@toStringTag
- Defined in String.ts:63
The string to use for the default toString function

Returns string

get

get(): string

Implementation of IMutable.get

Inherited from String.get
- Defined in String.ts:105
Returns string

set

set(value: Accepted | Any): IBase

Overrides CheckedString.set
- Defined in Guid.ts:218
Parameters
- value: Accepted | Any
Returns IBase

toJSON

toJSON(_?: string): any | number | string | boolean | null

Implementation of IMutable.toJSON

Inherited from String.toJSON
- Defined in String.ts:89
Converts the primitive into it's JSON representation

Parameters
- Default value _: string = ""
Returns any | number | string | boolean | null

the object to serialize with JSON.stringify

toString

toString(): string

Implementation of IMutable.toString

Inherited from CheckedString.toString

Overrides String.toString
- Defined in checked/String.ts:43
Converts the primitive into it's string representation

Returns string

valueOf

valueOf(): string

Implementation of IMutable.valueOf

Inherited from String.valueOf
- Defined in String.ts:96
Retrieves the actual value of the number

Returns string