Options
All
  • Public
  • Public/Protected
  • All
Menu

This class implements a ParserSource interface for NodeJS readable streams.

Hierarchy

  • NodeStreamSource

Index

Constructors

Properties

Methods

Constructors

constructor

  • Construct a NodeStreamSource using the given NodeJS readable stream object. Note that the encoding of the stream will not be changed by this object - in most cases, you will want to set the stream's encoding to "utf8" either when the stream was constructed or using a "setEncoding" method.

    Parameters

    • readable: NodeStream.Readable

      The NodeJS readable stream object which should be used as a basis for this iterator.

    Returns NodeStreamSource

Properties

buffer

buffer: string = ""

eof

eof: boolean = false

index

index: number = 0

Optional readable

readable: NodeStream.Readable

Methods

next

  • next(): IteratorResult<string>
  • Implement ES6 iterator interface.

    Returns IteratorResult<string>

    An ES6 iterator result object having "done" and "value" properties.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc