Class HSymbol

Haystack symbol.

Implements

HVal

Index

Accessors

Methods

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

Accessors

value

get value(): string
Returns string
The symbol value.
- Defined in src/core/HSymbol.ts:74
set value(value: string): void
Parameters
- value: string
Returns void
- Defined in src/core/HSymbol.ts:78

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/HSymbol.ts:152

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/HSymbol.ts:139

getKind

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

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/HSymbol.ts:116

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/HSymbol.ts:95

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/HSymbol.ts:106

newCopy

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

toAxon

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

toDict

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

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/HSymbol.ts:129

toGrid

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

toJSON

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

toJSONString

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

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/HSymbol.ts:209

toJSONv3

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

toList

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

toString

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

toZinc

toZinc(): string
Encode to zinc encoding.

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

valueOf

valueOf(): string
Returns string
A encoded reference.
- Defined in src/core/HSymbol.ts:176

`Static`make

make(value: string | HaysonKindVal | HSymbol): HSymbol
Makes a haystack symbol.
Parameters
- value: string | HaysonKindVal | HSymbol
  The value string or Hayson symbol object.
Returns HSymbol
A haystack symbol.
- Defined in src/core/HSymbol.ts:51