Class HXStr

Haystack XStr.

Hierarchy

HXStr

Implements

HVal

Index

Accessors

Methods

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

Accessors

type

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

value

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

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

equals

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

getKind

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

inspect

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

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

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

newCopy

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

toAxon

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

toDict

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

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

toGrid

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

toJSON

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

toJSONv3

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

toList

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

toString

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

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

valueOf

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

`Static` make

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

Generated using TypeDoc