Class HTime

Haystack time.

Implements

HVal

Index

Accessors

date

get date(): Date
Returns Date
The Date for this time.
- Defined in src/core/HTime.ts:274

hours

get hours(): number
Returns number
The hours in a 24 hour format.
- Defined in src/core/HTime.ts:117
set hours(hours: number): void
Parameters
- hours: number
Returns void
- Defined in src/core/HTime.ts:121

milliseconds

get milliseconds(): number
Returns number
The milliseconds.
- Defined in src/core/HTime.ts:150
set milliseconds(milliseconds: number): void
Parameters
- milliseconds: number
Returns void
- Defined in src/core/HTime.ts:154

minutes

get minutes(): number
Returns number
The minutes.
- Defined in src/core/HTime.ts:128
set minutes(minutes: number): void
Parameters
- minutes: number
Returns void
- Defined in src/core/HTime.ts:132

seconds

get seconds(): number
Returns number
The seconds.
- Defined in src/core/HTime.ts:139
set seconds(seconds: number): void
Parameters
- seconds: number
Returns void
- Defined in src/core/HTime.ts:143

value

get value(): string
Returns string
The time value.
- Defined in src/core/HTime.ts:106
set value(value: string): void
Parameters
- value: string
Returns void
- Defined in src/core/HTime.ts:110

Methods

compareTo

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

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/HTime.ts:215

getKind

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

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/HTime.ts:192

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/HTime.ts:171

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/HTime.ts:182

newCopy

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

toAxon

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

toDict

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

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/HTime.ts:205

toGrid

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

toJSON

toJSON(): HaysonKindVal
Returns HaysonKindVal
A JSON reprentation of the object.
Implementation of HVal.toJSON
- Defined in src/core/HTime.ts:327

toJSONString

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

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/HTime.ts:344

toJSONv3

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

toList

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

toString

toString(): string
Returns string
A string representation of the value.
Implementation of HVal.toString
- Defined in src/core/HTime.ts:244

toZinc

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

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

valueOf

valueOf(): string
Returns string
The encoded time value.
- Defined in src/core/HTime.ts:251

`Static`make

make(value: string | HaysonKindVal | Date | TimeObj | HTime): HTime
Makes a haystack time.
Parameters
- value: string | HaysonKindVal | Date | TimeObj | HTime
  The value.
Returns HTime
A haystack time.
- Defined in src/core/HTime.ts:95

`Static`now

now(): HTime
Returns HTime
The current time.
- Defined in src/core/HTime.ts:267