Interface HVal

The interface for a haystack value.

Each haystack encoded value should declare a static factory 'make' method used for creating values. All constructors should be kept private (or protected).

Hierarchy

HVal

Implemented by

Index

Methods

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

Methods

compareTo

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

equals

equals(value): boolean
Value equality check.
Parameters
- value: unknown
  
  The value used to check for equality.
Returns boolean
True if the value is the same.
- Defined in src/core/HVal.ts:172

getKind

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

inspect

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

isKind

isKind(kind): boolean
Compares the value's kind.
Parameters
- kind: Kind
  
  The kind to compare against.
Returns boolean
True if the kind matches.
- Defined in src/core/HVal.ts:164

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.
- Defined in src/core/HVal.ts:235

newCopy

newCopy(): HVal
Returns a new copy of the underlying value.

If the value is immutable, the value will simply return itself. If mutable, the value will return a brand new copy of the value.

Returns HVal
A value.
- Defined in src/core/HVal.ts:253

toAxon

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

toDict

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

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.
- Defined in src/core/HVal.ts:191

toGrid

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

toJSON

toJSON(): HaysonVal
Returns HaysonVal
A JSON reprentation of the object.
- Defined in src/core/HVal.ts:205

toJSONv3

toJSONv3(): JsonV3Val
Encode the value using the older Haystack version 3 JSON encoding. Please note, this has been supplanted by the newer Hayson JSON format (use toJSON).

https://project-haystack.org/doc/docHaystack/Json

Returns JsonV3Val
A JSON v3 representation of the object.
- Defined in src/core/HVal.ts:216

toList

toList(): HList<OptionalHVal>
Returns HList<OptionalHVal>
The value as a list.
- Defined in src/core/HVal.ts:263

toString

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

toZinc

toZinc(nested?): string
Encodes to an encoding zinc value.
Parameters
- Optional nested: boolean
  
  An optional flag used to indiciate whether the value being encoded is nested.
Returns string
The encoded zinc string.
- Defined in src/core/HVal.ts:200

Generated using TypeDoc