Class HRef

Haystack ref.

Implements

HVal

Index

Accessors

dis

get dis(): string
Returns string
The display name value in shorthand.
- Defined in src/core/HRef.ts:96
set dis(value: string): void
Parameters
- value: string
Returns void
- Defined in src/core/HRef.ts:100

displayName

get displayName(): string
Returns string
The display name value.
- Defined in src/core/HRef.ts:107
set displayName(value: string): void
Parameters
- value: string
Returns void
- Defined in src/core/HRef.ts:111

value

get value(): string
Returns string
The ref value.
- Defined in src/core/HRef.ts:85
set value(value: string): void
Parameters
- value: string
Returns void
- Defined in src/core/HRef.ts:89

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/HRef.ts:182

equals

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

getKind

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

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/HRef.ts:149

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/HRef.ts:128

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

newCopy

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

noDis

noDis(): HRef
Returns HRef
A ref with no display name.
- Defined in src/core/HRef.ts:283

toAxon

toAxon(): string
Returns string
An Axon encoded string.
Implementation of HVal.toAxon
- Defined in src/core/HRef.ts:269

toDict

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

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/HRef.ts:162

toGrid

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

toJSON

toJSON(): HaysonRef
Returns HaysonRef
A JSON reprentation of the object.
Implementation of HVal.toJSON
- Defined in src/core/HRef.ts:230

toJSONString

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

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/HRef.ts:253

toJSONv3

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

toList

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

toString

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

toZinc

toZinc(excludeDis?: boolean): string
Encode to zinc encoding.
Parameters
- OptionalexcludeDis: boolean
Returns string
The encoded zinc string.

Params
excludeDis Excludes the display name from the encoding.
Implementation of HVal.toZinc
- Defined in src/core/HRef.ts:216

valueOf

valueOf(): string
Returns string
The ref's value.
- Defined in src/core/HRef.ts:206

`Static`make

make(value: string | HaysonRef | HStr | HRef, displayName?: string): HRef
Makes a Haystack ref.
Parameters
- value: string | HaysonRef | HStr | HRef
  The value or hayson ref.
- OptionaldisplayName: string
  Optional display string for a reference.
Returns HRef
A haystack ref.
- Defined in src/core/HRef.ts:71