Class HDate

Haystack date.

Hierarchy

HDate

Implements

HVal

Index

Accessors

date day month value year

Methods

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

Accessors

date

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

day

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

month

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

value

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

year

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

Methods

compareTo

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

equals

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

getKind

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

inspect

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

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

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

newCopy

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

toAxon

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

toDict

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

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

toGrid

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

toJSON

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

toJSONv3

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

toList

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

toString

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

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

valueOf

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

`Static` make

make(value): 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:99

`Static` now

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

Generated using TypeDoc