Class HDate

Haystack date.

Implements

HVal

Index

Accessors

date day month value year

Methods

compareTo equals getKind inspect isKind matches newCopy toAxon toDict toFilter toGrid toJSON toJSONString toJSONUint8Array toJSONv3 toList toString toZinc valueOf make now

Accessors

date

get date(): Date
Returns Date
A JS date object.
- Defined in src/core/HDate.ts:219

day

get day(): number
Returns number
The day for the date.
- Defined in src/core/HDate.ts:255
set day(day: number): void
Parameters
- day: number
Returns void
- Defined in src/core/HDate.ts:259

month

get month(): number
Returns number
The month for the date.
- Defined in src/core/HDate.ts:244
set month(month: number): void
Parameters
- month: number
Returns void
- Defined in src/core/HDate.ts:248

value

get value(): string
Returns string
The date value.
- Defined in src/core/HDate.ts:111
set value(value: string): void
Parameters
- value: string
Returns void
- Defined in src/core/HDate.ts:115

year

get year(): number
Returns number
The year for the date.
- Defined in src/core/HDate.ts:233
set year(year: number): void
Parameters
- year: number
Returns void
- Defined in src/core/HDate.ts:237

Methods

compareTo

compareTo(value: unknown): number
Compares two dates.
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/HDate.ts:175

equals

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

getKind

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

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/HDate.ts:153

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/HDate.ts:132

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/HDate.ts:143

newCopy

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

toAxon

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

toDict

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

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

toGrid

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

toJSON

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

toJSONString

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

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/HDate.ts:332

toJSONv3

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

toList

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

toString

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

toZinc

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

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

valueOf

valueOf(): string
Returns string
The date as a string.
- Defined in src/core/HDate.ts:212

`Static`make

make(value: string | HaysonKindVal | DateObj | HDate | Date): HDate
Factory method for a haystack date.
Parameters
- value: string | HaysonKindVal | DateObj | HDate | Date
  The value as a string, date object or an object literal with year, month and day values.
Returns HDate
The haystack date.
- Defined in src/core/HDate.ts:100

`Static`now

now(): HDate
Returns HDate
Today's date.
- Defined in src/core/HDate.ts:226