Class DateValue

Domain primitive representing a date value.

Hierarchy (view full)

DomainPrimitive<Date>
- DateValue

Index

Constructors

Properties

Methods

[toPrimitive] equals iso notEquals unpack validate UTC isDomainPrimitive isValueObject now parse

Constructors

constructor

new DateValue(value): DateValue
Parameters
- value: string | number | Date
Returns DateValue
Overrides DomainPrimitive.constructor
- Defined in lib/core/src/value-objects/date-value.ts:8

Properties

`Protected` `Readonly`value

value: Date

`Static`null

null: DateValue = ...

Represents a null date 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<Date>
Returns boolean
Inherited from DomainPrimitive.equals
- Defined in lib/core/src/value-objects/domain-primitive.ts:30

iso

iso(): string
Returns the date value as a string.

Returns string
- Defined in lib/core/src/value-objects/date-value.ts:15

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

unpack

unpack(): Date
Returns the DomainPrimitive value.

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

`Protected`validate

validate(): void
Returns the date value as a string.

Returns void
Overrides DomainPrimitive.validate
- Defined in lib/core/src/value-objects/date-value.ts:22

`Static`UTC

UTC(...params): DateValue
Returns the date value as a string.
Parameters
- Rest...params: [year: number, monthIndex?: number, date?: number, hours?: number, minutes?: number, seconds?: number, ms?: number]
Returns DateValue
- Defined in lib/core/src/value-objects/date-value.ts:37

`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

`Static`now

now(): DateValue
Returns the date value as a string.

Returns DateValue
- Defined in lib/core/src/value-objects/date-value.ts:30

`Static`parse

parse(...params): DateValue
Returns the date value as a string.
Parameters
- Rest...params: [s: string]
Returns DateValue
- Defined in lib/core/src/value-objects/date-value.ts:44