Class Identity<Value>`Abstract`

Identity DomainPrimitive containing unique ID values.

Type Parameters

Value extends string | number = string | number

Hierarchy (view full)

DomainPrimitive<Value>
- Identity

Index

Constructors

Properties

Methods

[toPrimitive] equals notEquals toString unpack validate isDomainPrimitive isValueObject

Constructors

constructor

new Identity<Value>(value): Identity<Value>
Type Parameters
- Value extends string | number = string | number
Parameters
- value: Value
Returns Identity<Value>
Inherited from DomainPrimitive.constructor
- Defined in lib/core/src/value-objects/domain-primitive.ts:15

Properties

`Protected` `Readonly`value

value: Value

Methods

[toPrimitive]

[toPrimitive](hint): string
Converts a DomainPrimitive object to a string.
Parameters
- hint: "string"
Returns string
Inherited from DomainPrimitive.[toPrimitive]
- Defined in lib/core/src/value-objects/domain-primitive.ts:41
[toPrimitive](hint): number
Converts a DomainPrimitive object to a number.
Parameters
- hint: "number"
Returns number
Inherited from DomainPrimitive.[toPrimitive]
- Defined in lib/core/src/value-objects/domain-primitive.ts:45
[toPrimitive](hint): string
Converts a DomainPrimitive object to a string.
Parameters
- hint: "default"
Returns string
Inherited from DomainPrimitive.[toPrimitive]
- Defined in lib/core/src/value-objects/domain-primitive.ts:49

equals

equals(object): boolean
Returns true if the DomainPrimitive value is null.
Parameters
- object: DomainPrimitive<Value>
Returns boolean
Inherited from DomainPrimitive.equals
- Defined in lib/core/src/value-objects/domain-primitive.ts:30

notEquals

notEquals(object): boolean
Inverse of the equals method.
Parameters
- object: ValueObject
Returns boolean
Inherited from DomainPrimitive.notEquals
- Defined in lib/core/src/value-objects/value-object.ts:26

toString

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

Returns string
- Defined in lib/core/src/entities/identity.ts:9

unpack

unpack(): Value
Returns the DomainPrimitive value.

Returns Value
Inherited from DomainPrimitive.unpack
- Defined in lib/core/src/value-objects/domain-primitive.ts:23

`Protected` `Abstract`validate

validate(): void
Validates the DomainPrimitive value.

Returns void
Inherited from DomainPrimitive.validate
- Defined in lib/core/src/value-objects/domain-primitive.ts:77

`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 DomainPrimitive.isDomainPrimitive
- Defined in lib/core/src/value-objects/domain-primitive.ts:82

`Static`isValueObject

isValueObject(obj): obj is ValueObject
Returns true if the argument is a ValueObject.
Parameters
- obj: unknown
Returns obj is ValueObject
Inherited from DomainPrimitive.isValueObject
- Defined in lib/core/src/value-objects/value-object.ts:33