Class HXStr

Haystack XStr.

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

type

get type(): string
Returns string
The type value.
- Defined in src/core/HXStr.ts:73
set type(type: string): void
Parameters
- type: string
Returns void
- Defined in src/core/HXStr.ts:77

value

get value(): string
Returns string
The value.
- Defined in src/core/HXStr.ts:84
set value(value: string): void
Parameters
- value: string
Returns void
- Defined in src/core/HXStr.ts:88

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/HXStr.ts:173

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/HXStr.ts:159

getKind

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

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/HXStr.ts:126

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/HXStr.ts:105

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

newCopy

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

toAxon

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

toDict

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

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/HXStr.ts:198

toGrid

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

toJSON

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

toJSONString

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

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/HXStr.ts:223

toJSONv3

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

toList

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

toString

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

toZinc

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

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

valueOf

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

`Static`make

make(type: string | HaysonXStr | HXStr, value?: string): HXStr
Make a haystack xstring.
Parameters
- type: string | HaysonXStr | HXStr
  The type or an hayson xstr object.
- Optionalvalue: string
  The value.
Returns HXStr
A haystack xstring.
- Defined in src/core/HXStr.ts:62