Class HMarker

Haystack marker value.

Hierarchy

HMarker

Implements

HVal

Index

Methods

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

Methods

compareTo

compareTo(value): 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/HMarker.ts:139

equals

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

getKind

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

inspect

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

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/HMarker.ts:63

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/HMarker.ts:74

newCopy

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

toAxon

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

toDict

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

toFilter

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

A dict isn't supported in filter so throw an error.

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

toGrid

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

toJSON

toJSON(): HaysonSingleton
Returns HaysonSingleton
A JSON reprentation of the object.
Implementation of HVal.toJSON
- Defined in src/core/HMarker.ts:146

toJSONv3

toJSONv3(): "m:"
Returns "m:"
A JSON v3 representation of the object.
Implementation of HVal.toJSONv3
- Defined in src/core/HMarker.ts:153

toList

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

toString

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

toZinc

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

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

valueOf

valueOf(): string
Returns string
The zinc encoded string.
- Defined in src/core/HMarker.ts:98

`Static` make

make(): HMarker
Makes a marker.

Returns HMarker
A marker instance.
- Defined in src/core/HMarker.ts:46

Generated using TypeDoc