-
Notifications
You must be signed in to change notification settings - Fork 0
FloatString
ValueObjects! a floating point number that can also be created from a string representation of a floating point number
-
↳
FloatString
- equals
- toJSON
- create
- fromList
- listEquals
- parse
- prefix
- toList
- validate
- validateFloatString
- validateInterval
- validateList
- validateNumber
• Protected
new FloatString(value
)
Name | Type |
---|---|
value |
number |
valueObjects/numeric/FloatString.ts:6
• Protected
Readonly
_value: number
the actual value of the ValueObject
• get
value(): T
the actual value of this ValueObject
T
Float.value
valueObjects/ValueObject.ts:13
▸ equals(obj
): boolean
compares if the given value is either an equal ValueObject, or an equal value which would create an equal ValueObject
Name | Type | Description |
---|---|---|
obj |
string | number | FloatString
|
to compare of equality |
boolean
valueObjects/numeric/FloatString.ts:10
▸ toJSON(): number
this function is invoked by JSON.stringify()
and converts the inner "_propertyKey"
to "propertyKey"
number
the value
valueObjects/ValueObject.ts:61
▸ Static
create(value
, options?
): FloatString
Name | Type | Description |
---|---|---|
value |
string | number
|
to create the ValueObject of |
options? |
IntervalCreationOptions |
constraints the value has to fulfill |
the created ValueObject
valueObjects/numeric/FloatString.ts:72
▸ Static
fromList(values
, options?
): FloatString
[]
Name | Type | Description |
---|---|---|
values |
undefined | (string | number )[] |
an array of primitives to map to an array of ValueObjects |
options? |
IntervalCreationOptions & ListCreationOptions
|
constraints the values / list has to fulfill |
the array of ValueObjects
valueObjects/numeric/FloatString.ts:81
▸ Static
listEquals<ValueType
>(a
, b
): boolean
compares 2 Lists of ValueObjects / values on equality
Name |
---|
ValueType |
Name | Type | Description |
---|---|---|
a |
ValueObject <ValueType >[] |
the list of ValueObjects to compare with |
b |
ValueObject <ValueType >[] | ValueType [] |
a list of ValueObjects / values for comparison |
boolean
true if the lists are equal
valueObjects/ValueObject.ts:29
▸ Static
parse(value
): number
parses the given string to a (float) number where a possible ,
will be correctly replaced by a .
.
Name | Type | Description |
---|---|---|
value |
string |
to parse (unchecked) |
number
the parsed number OR NaN
if not parsable
valueObjects/numeric/FloatString.ts:61
▸ Static
Protected
prefix(options
, addition?
): string
constructs a prefix for possible error messages based on the ValueObjects name and an additional string:
- example for NonEmptyString with
name='Person'
:
"Person > NonEmptyString"
Name | Type | Default value | Description |
---|---|---|---|
options |
undefined | CreationOptions
|
undefined |
the CreationOptions where the optional name: string is taken from |
addition |
string |
'' |
An additional name which will be added as "name.addition"
|
string
the name of the ValueObject
valueObjects/ValueObject.ts:77
▸ Static
toList(values
): number
[]
Name | Type | Description |
---|---|---|
values |
FloatString [] |
an array of ValueObjects to map to an array of their values |
number
[]
the array of values
valueObjects/numeric/FloatString.ts:92
▸ Static
validate(value
, options?
): number
Throws
TypeError if not a positive number
Throws
RangeError if the value is not inside the interval
Name | Type | Description |
---|---|---|
value |
string | number
|
to be validated as a float with the corresponding constraints (options) |
options? |
IntervalCreationOptions |
constraints the value has to fulfill |
number
the value if the validation was successful
valueObjects/numeric/FloatString.ts:26
▸ Static
Protected
validateFloatString(value
, options?
): number
Name | Type | Description |
---|---|---|
value |
string | number
|
to be validated as a valid number / string representation of a valid number |
options? |
IntervalCreationOptions |
constraints the value has to fulfill |
number
the (possibly parsed) number
valueObjects/numeric/FloatString.ts:37
▸ Static
Protected
validateInterval(value
, options
): void
Name | Type |
---|---|
value |
string | number
|
options |
IntervalCreationOptions |
void
valueObjects/ValueObject.ts:86
▸ Static
Protected
validateList<Primitive
>(list
, options?
): list is Primitive[]
Name |
---|
Primitive |
Name | Type |
---|---|
list |
undefined | Primitive [] |
options? |
CreationOptions & ListCreationOptions
|
list is Primitive[]
valueObjects/ValueObject.ts:101
▸ Static
Protected
validateNumber(value
, options?
): void
Name | Type | Description |
---|---|---|
value |
number |
to be validated as a valid number (not NaN) |
options? |
IntervalCreationOptions |
constraints the value has to fulfill |
void