Class ValueObject

A basic ValueObject that wraps a primitive value immutably and does validation on creation

Type Parameters

T

Hierarchy

ValueObject

Index

Accessors

Methods

equals toJSON listEquals

Accessors

value

get value(): T
the actual value of this ValueObject

Returns T
- Defined in valueObjects/ValueObject.ts:15

Methods

`Abstract` equals

equals(obj: unknown): boolean
compares if the given value is either an equal ValueObject, or an equal value which would create an equal ValueObject
Parameters
- obj: unknown
  
  to compare of equality
Returns boolean
- Defined in valueObjects/ValueObject.ts:23

toJSON

toJSON(): T
this function is invoked by JSON.stringify() and returns the internal value

Returns T
- Defined in valueObjects/ValueObject.ts:54

`Static` listEquals

listEquals<ValueType>(a: ValueObject<ValueType>[], b: ValueObject<ValueType>[] | ValueType[]): boolean
compares 2 Lists of ValueObjects / values on equality

Returns
true if the lists are equal
Type Parameters
- ValueType
Parameters
- a: ValueObject<ValueType>[]
  
  the list of ValueObjects to compare with
- b: ValueObject<ValueType>[] | ValueType[]
  
  a list of ValueObjects / values for comparison
Returns boolean
- Defined in valueObjects/ValueObject.ts:31

Generated using TypeDoc