Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • BinaryReader

Implements

Index

Constructors

constructor

Methods

annotations

  • annotations(): string[]

bigIntValue

  • bigIntValue(): null | bigint

booleanValue

  • booleanValue(): null | boolean

decimalValue

depth

  • depth(): number

fieldName

  • fieldName(): null | string

getAnnotation

  • getAnnotation(index: number): string

hasAnnotations

  • hasAnnotations(): boolean

intSize

isNull

  • isNull(): boolean

next

numberValue

  • numberValue(): null | number

position

  • position(): number
  • Returns the Reader's offset from the beginning of its input.

    For binary Readers, the return value is the number of bytes that have been processed.

    For text Readers, the return value is the number of UTF-16 code units that have been processed, regardless of the input's original encoding. For more on JavaScript's in-memory representation of text, see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/length#Description

    Note that a Reader cannot safely skip to a given position in input without processing the stream leading up to that position. This is because there are mid-stream system level values that must be processed to guarantee that the Reader is in a valid state. It is safe, however, to start at the beginning of a data source and call next() until you reach the desired position, as the reader will still have the opportunity to process system-level values along the way.

    Returns number

stepIn

  • stepIn(): void
  • Steps into the container the reader is currently positioned on. Note that this positions the reader before the first value within the container.

    Returns void

stepOut

  • stepOut(): void
  • Steps out of the current container. This is only valid when the reader is inside of a container (i.e. depth() > 0). Note that the positions the reader after the container that was stepped out of, but before the next value after the container. One should generally call next after invoking this method.

    Returns void

stringValue

  • stringValue(): null | string
  • Returns the current value as a string. This is only valid if type() == IonTypes.STRING or type() == IonTypes.SYMBOL.

    Returns null | string

timestampValue

type

uInt8ArrayValue

  • uInt8ArrayValue(): null | Uint8Array

value

  • value(): any