Class ValueObjectAbstract<Type>`Abstract`

Abstract class for representing an object value

Export

Abstract

Since

1.0.0

Version

1.0.0

License

MIT

Author

Julian Andres Lasso Figueroa julian.lasso@sofka.com.co

Type Parameters

Type

Type of value represented by the value object

Hierarchy

ValueObjectAbstract

Index

Constructors

Properties

Accessors

Methods

getErrors hasErrors hasValue restartErrors setError validateData valueOf verifyValue

Constructors

constructor

new ValueObjectAbstract<Type>(value?: Type): ValueObjectAbstract<Type>
Creates an instance of ValueObjectBase

Memberof
ValueObjectBase
Type Parameters
- Type
Parameters
- Optional value: Type
  
  Initial value of the object value
Returns ValueObjectAbstract<Type>
- Defined in src/abstracts/value-object.abstract.ts:50

Properties

`Private` _errors

_errors: IErrorValueObject[]

Value Object Error Stack

Memberof

ValueObjectAbstract

`Private` _value

_value: Type

Value of the Value Object

Memberof

ValueObjectAbstract

Accessors

value

set value(value: Type): void
Sets the value for the value object, resets the error stack, and validates the new value

Memberof
ValueObjectBase
Parameters
- value: Type
Returns void
- Defined in src/abstracts/value-object.abstract.ts:62

Methods

getErrors

getErrors(): IErrorValueObject[]
Returns an array of validation errors for the value object

Returns
Array of validation errors for the value object

Memberof
ValueObjectBase

Returns IErrorValueObject[]
- Defined in src/abstracts/value-object.abstract.ts:104

hasErrors

hasErrors(): boolean
Returns true if there are validation errors, false otherwise

Returns
True if there are validation errors, false otherwise

Memberof
ValueObjectBase

Returns boolean
- Defined in src/abstracts/value-object.abstract.ts:93

hasValue

hasValue(): boolean
Return true if the value object has a value, false otherwise

Returns
{boolean} - True if the value object has a value, false otherwise

Memberof
ValueObjectAbstract

Returns boolean
- Defined in src/abstracts/value-object.abstract.ts:74

`Private` restartErrors

restartErrors(): void
Private
Clears all validation errors of the value object

Memberof
ValueObjectBase

Returns void
- Defined in src/abstracts/value-object.abstract.ts:125

`Protected` setError

setError(error: IErrorValueObject): void
Protected
Sets a validation error for the value object

Memberof
ValueObjectBase
Parameters
- error: IErrorValueObject
  
  Validation error to set
Returns void
- Defined in src/abstracts/value-object.abstract.ts:115

`Abstract` validateData

validateData(): void
Validates the value of the value object. This method must be implemented in the derived classes

Abstract

Memberof
ValueObjectBase

Returns void
- Defined in src/abstracts/value-object.abstract.ts:85

valueOf

valueOf(): Type
Returns the primitive value of the specified object

Returns
Primitive value of the specified object

Memberof
ValueObjectBase

Returns Type
- Defined in src/abstracts/value-object.abstract.ts:135

`Private` verifyValue

verifyValue(): void
Private
Verify if the value object has any errors

Throws
Throws an exception with the value object errors if it has any

Memberof
ValueObjectAbstract

Returns void
- Defined in src/abstracts/value-object.abstract.ts:148

Generated using TypeDoc