Class ZincReader

A Zinc reader.

See

https://project-haystack.org/doc/Zinc

Hierarchy

ZincReader

Index

Constructors

Methods

numberDateTime readValue ref string symbol tagName uri readValue

Constructors

constructor

new ZincReader(input): ZincReader
Constructors a new reader.
Parameters
- input: string | Scanner
  
  The scanner used for the input.
Returns ZincReader
- Defined in src/core/ZincReader.ts:49

Methods

numberDateTime

numberDateTime(): HDate | HNum | HTime | HDateTime
Consume the data stream and return a number, date or time value.

Returns HDate | HNum | HTime | HDateTime
A number, date, date time or time value.

Throws
If we don't have a valid number.
- Defined in src/core/ZincReader.ts:396

readValue

readValue(): undefined | null | HVal
Read the value and return it.

Returns undefined | null | HVal
The next value.
- Defined in src/core/ZincReader.ts:68

ref

ref(): HRef
Consume the data stream and return an ref value.

Returns HRef
A ref value.

Throws
If there's an error parsing the ref.
- Defined in src/core/ZincReader.ts:289

string

string(): HStr
Consume the data stream and return a string value.

Returns HStr
A string value.

Throws
If the end of the string can't be found.
- Defined in src/core/ZincReader.ts:203

symbol

symbol(): HSymbol
Returns HSymbol
A symbol value.
- Defined in src/core/ZincReader.ts:774

tagName

tagName(): string
Returns string
A tag name.
- Defined in src/core/ZincReader.ts:743

uri

uri(): HUri
Consume the data stream and return an uri value.

Returns HUri
A uri value.

Throws
If the end of the uri can't be found if an invalid character is found.
- Defined in src/core/ZincReader.ts:237

`Static` readValue

readValue(input): undefined | null | HVal
Read the input zinc encoded string and return the haystack value for it.
Parameters
- input: string | Scanner
  
  The input string or scanner.
Returns undefined | null | HVal
The haystack value.
- Defined in src/core/ZincReader.ts:59

Generated using TypeDoc