Class Uuid

Universally Unique Identifier (RFC4122).

Hierarchy (view full)

Identity<string>
- Uuid

Index

Constructors

Properties

Methods

[toPrimitive] equals notEquals toString unpack validate generate isDomainPrimitive isValueObject

Constructors

constructor

new Uuid(value): Uuid
Parameters
- value: string
Returns Uuid
Inherited from Identity.constructor
- Defined in core/dist/value-objects/domain-primitive.d.ts:11

Properties

`Protected` `Readonly`value

value: string

`Protected` `Static` `Readonly`nil

nil: "00000000-0000-0000-0000-000000000000" = '00000000-0000-0000-0000-000000000000'

Nil/Empty UUID.

Methods

[toPrimitive]

[toPrimitive](hint): string
Converts a DomainPrimitive object to a string.
Parameters
- hint: "string"
Returns string
Inherited from Identity.[toPrimitive]
- Defined in core/dist/value-objects/domain-primitive.d.ts:23
[toPrimitive](hint): number
Converts a DomainPrimitive object to a number.
Parameters
- hint: "number"
Returns number
Inherited from Identity.[toPrimitive]
- Defined in core/dist/value-objects/domain-primitive.d.ts:27
[toPrimitive](hint): string
Converts a DomainPrimitive object to a string.
Parameters
- hint: "default"
Returns string
Inherited from Identity.[toPrimitive]
- Defined in core/dist/value-objects/domain-primitive.d.ts:31

equals

equals(object): boolean
Returns true if the DomainPrimitive value is null.
Parameters
- object: DomainPrimitive<string>
Returns boolean
Inherited from Identity.equals
- Defined in core/dist/value-objects/domain-primitive.d.ts:19

notEquals

notEquals(object): boolean
Inverse of the equals method.
Parameters
- object: ValueObject
Returns boolean
Inherited from Identity.notEquals
- Defined in core/dist/value-objects/value-object.d.ts:19

toString

toString(): string
Returns a string representation of an object.

Returns string
Inherited from Identity.toString
- Defined in core/dist/entities/identity.d.ts:6

unpack

unpack(): string
Returns the DomainPrimitive value.

Returns string
Inherited from Identity.unpack
- Defined in core/dist/value-objects/domain-primitive.d.ts:15

`Protected`validate

validate(): void
Validates the DomainPrimitive value.

Returns void
Overrides Identity.validate
- Defined in uuid/src/uuid.ts:8

`Static`generate

generate(options?): string
Returns a randomly generated v4 UUID attribute.
Parameters
- Optionaloptions: V4Options
Returns string
- Defined in uuid/src/uuid.ts:16

`Static`isDomainPrimitive

isDomainPrimitive<T>(obj): obj is DomainPrimitive<T>
Returns true if the object is a DomainPrimitive.
Type Parameters
- T extends Primitive
Parameters
- obj: unknown
Returns obj is DomainPrimitive<T>
Inherited from Identity.isDomainPrimitive
- Defined in core/dist/value-objects/domain-primitive.d.ts:39

`Static`isValueObject

isValueObject(obj): obj is ValueObject
Returns true if the argument is a ValueObject.
Parameters
- obj: unknown
Returns obj is ValueObject
Inherited from Identity.isValueObject
- Defined in core/dist/value-objects/value-object.d.ts:23