Class HNum

Haystack number with units.

Implements

HVal

Index

Accessors

unit

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

value

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

Methods

compareTo

compareTo(value: unknown): 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:331

convertTo

convertTo(unit: HUnit): 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:569

divide

divide(num: HNum): 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:541

equals

equals(value: unknown): 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:309

getKind

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

inspect

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

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:369

isKind

isKind(kind: 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:186

matches

matches(filter: string | Node, cx?: Partial<EvalContext>): boolean
Returns true if the haystack filter matches the value.
Parameters
- filter: string | Node
  The filter to test.
- Optionalcx: 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:197

minus

minus(num: HNum): 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:484

multiply

multiply(num: HNum): 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:516

newCopy

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

plus

plus(num: HNum): 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:470

toAxon

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

toDict

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

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:262

toGrid

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

toJSON

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

toJSONString

toJSONString(): string
Returns string
A string containing the JSON representation of the object.
Implementation of HVal.toJSONString
- Defined in src/core/HNum.ts:410

toJSONUint8Array

toJSONUint8Array(): Uint8Array
Returns Uint8Array
A byte buffer that has an encoded JSON string representation of the object.
Implementation of HVal.toJSONUint8Array
- Defined in src/core/HNum.ts:417

toJSONv3

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

toList

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

toString

toString(options?: number | NumberFormatOptions): string
Return the number as a readable string.
Parameters
- Optionaloptions: number | NumberFormatOptions
Returns string
A string representation of the value.
Implementation of HVal.toString
- Defined in src/core/HNum.ts:225

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:279

valueOf

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

`Static`make

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