Class HNum

Haystack number with units.

Hierarchy

HNum

Implements

HVal

Index

Accessors

Methods

compareTo convertTo divide equals getKind inspect isDuration isKind matches minus multiply newCopy plus toAxon toDict toFilter toGrid toJSON toJSONv3 toList toString toZinc valueOf make

Accessors

unit

get unit(): undefined | HUnit
Returns undefined | HUnit
Optional unit value for a number.
- Defined in src/core/HNum.ts:136
set unit(unit): void
Parameters
- unit: undefined | HUnit
Returns void
- Defined in src/core/HNum.ts:156

value

get value(): number
Returns number
The numeric value.
- Defined in src/core/HNum.ts:125
set value(value): void
Parameters
- value: number
Returns void
- Defined in src/core/HNum.ts:129

Methods

compareTo

compareTo(value): number
Compares two values.
Parameters
- value: unknown
  
  The number to compare.
Returns number
The sort order as negative, 0, or positive
Implementation of HVal.compareTo
- Defined in src/core/HNum.ts:307

convertTo

convertTo(unit): HNum
Convert the number to another unit.

Please note, the unit to convert to must be compatible otherwise an error is thrown.

If the current number does not have a unit then return a number with the specified unit and value.
Parameters
- unit: HUnit
  
  The unit to convert too.
Returns HNum
The new number with the new unit.

Throws
An error if the number can't be converted with the unit.
- Defined in src/core/HNum.ts:531

divide

divide(num): HNum
Divide this number by another.
Parameters
- num: HNum
  
  The number to divide by.
Returns HNum
The new number.

Throws
An error if the units are incompatible.
- Defined in src/core/HNum.ts:503

equals

equals(value): boolean
Value equality check.
Parameters
- value: unknown
  
  The value to test.
Returns boolean
True if the value is the same.
Implementation of HVal.equals
- Defined in src/core/HNum.ts:285

getKind

getKind(): Kind
Returns Kind
The value's kind.
Implementation of HVal.getKind
- Defined in src/core/HNum.ts:163

inspect

inspect(message?): HNum
Dump the value to the local console output.
Parameters
- Optional message: string
  
  An optional message to display before the value.
Returns HNum
The value instance.
Implementation of HVal.inspect
- Defined in src/core/HNum.ts:194

isDuration

isDuration(): boolean
Returns true if the number is a type of duration.

Returns boolean
True if the number is a duration.
- Defined in src/core/HNum.ts:345

isKind

isKind(kind): boolean
Compares the value's kind.
Parameters
- kind: Kind
  
  The kind to compare against.
Returns boolean
True if the kind matches.
Implementation of HVal.isKind
- Defined in src/core/HNum.ts:173

matches

matches(filter, cx?): boolean
Returns true if the haystack filter matches the value.
Parameters
- filter: string | Node
  
  The filter to test.
- Optional cx: Partial<EvalContext>
  
  Optional haystack filter evaluation context.
Returns boolean
True if the filter matches ok.
Implementation of HVal.matches
- Defined in src/core/HNum.ts:184

minus

minus(num): HNum
Subtract a number from this number.
Parameters
- num: HNum
  
  The number to subtract.
Returns HNum
The new number.

Throws
An error if the units are incompatible.
- Defined in src/core/HNum.ts:446

multiply

multiply(num): HNum
Multiply this number by another.
Parameters
- num: HNum
  
  The number to multiply by.
Returns HNum
The new number.

Throws
An error if the units are incompatible.
- Defined in src/core/HNum.ts:478

newCopy

newCopy(): HNum
Returns HNum
Returns the value instance.
Implementation of HVal.newCopy
- Defined in src/core/HNum.ts:400

plus

plus(num): HNum
Add a number to this number.
Parameters
- num: HNum
  
  The number to add.
Returns HNum
The new number.

Throws
An error if the units are incompatible.
- Defined in src/core/HNum.ts:432

toAxon

toAxon(): string
Returns string
An Axon encoded string of the value.
Implementation of HVal.toAxon
- Defined in src/core/HNum.ts:393

toDict

toDict(): HDict
Returns HDict
The value as a dict.
Implementation of HVal.toDict
- Defined in src/core/HNum.ts:421

toFilter

toFilter(): string
Encodes to an encoded zinc value that can be used in a haystack filter string.

The encoding for a haystack filter is mostly zinc but contains some exceptions.

Returns string
The encoded value that can be used in a haystack filter.
Implementation of HVal.toFilter
- Defined in src/core/HNum.ts:238

toGrid

toGrid(): HGrid<HDict>
Returns HGrid<HDict>
The value as a grid.
Implementation of HVal.toGrid
- Defined in src/core/HNum.ts:407

toJSON

toJSON(): number | HaysonNum
Returns number | HaysonNum
A JSON reprentation of the object.
Implementation of HVal.toJSON
- Defined in src/core/HNum.ts:352

toJSONv3

toJSONv3(): `n:${string}`
Returns `n:${string}`
A JSON v3 representation of the object.
Implementation of HVal.toJSONv3
- Defined in src/core/HNum.ts:386

toList

toList(): HList<HNum>
Returns HList<HNum>
The value as a list.
Implementation of HVal.toList
- Defined in src/core/HNum.ts:414

toString

toString(precision?): string
Return the number as a readable string.
Parameters
- precision: number = DEFAULT_PRECISION
  
  Optional precision. Default is 1 decimal place.
Returns string
A string representation of the value.
Implementation of HVal.toString
- Defined in src/core/HNum.ts:211

toZinc

toZinc(): string
Encodes to an encoding zinc value.

Returns string
The encoded zinc string.
Implementation of HVal.toZinc
- Defined in src/core/HNum.ts:255

valueOf

valueOf(): number
Returns number
The object's value as a number.
- Defined in src/core/HNum.ts:201

`Static` make

make(value, unit?): HNum
Makes a haystack number.
Parameters
- value: number | HaysonNum | HNum
  
  The value or a hayson number object.
- Optional unit: string | HUnit
  
  Optional units.
Returns HNum
A haystack number.
- Defined in src/core/HNum.ts:82

Generated using TypeDoc