Class HUri

Haystack URI.

Hierarchy

HUri

Implements

HVal

Index

Accessors

hash hostname pathname paths port query queryParams scheme value

Methods

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

Accessors

hash

get hash(): string
Returns string
the fragment identifier or an empty string if it can't be found.
- Defined in src/core/HUri.ts:317

hostname

get hostname(): string
Returns string
The host name or an empty string if it can't be found.
- Defined in src/core/HUri.ts:285

pathname

get pathname(): string
Returns string
The pathname or an empty string if none can be found.
- Defined in src/core/HUri.ts:300

paths

get paths(): string[]
Returns string[]
The paths or an empty array if no paths can be found.
- Defined in src/core/HUri.ts:307

port

get port(): number
Returns number
The port number being used or -1 if the port number can't be parsed for an unknown protocol.
- Defined in src/core/HUri.ts:293

query

get query(): string
Returns string
The whole query string.
- Defined in src/core/HUri.ts:324

queryParams

get queryParams(): Record<string, string>
Returns Record<string, string>
The parsed query object.
- Defined in src/core/HUri.ts:331

scheme

get scheme(): string
Return the scheme being used or an empty string if it can't be found.

Returns string
- Defined in src/core/HUri.ts:278

value

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

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

equals

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

getKind

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

inspect

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

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

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

newCopy

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

toAxon

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

toDict

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

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

toGrid

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

toJSON

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

toJSONv3

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

toList

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

toString

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

toZinc

toZinc(): string
Encode to zinc encoding.

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

valueOf

valueOf(): string
Returns string
The encoded URI value.
- Defined in src/core/HUri.ts:183

`Static` make

make(value): HUri
Makes a haystack URI.
Parameters
- value: string | HaysonKindVal | HUri
  
  The string value for the URI or a Hayson URI object.
Returns HUri
A haystack URI.
- Defined in src/core/HUri.ts:64

Generated using TypeDoc