Home Reference Source
import IteratorResult from 'iterator-result'
public class | source

IteratorResult

A basic iterator result.

Constructor Summary

Public Constructor
public

constructor(value: Object, done: Boolean)

Constructs a new iterator result.

Member Summary

Public Members
public

Whether this result is past the end of the iterated sequence.

public

The value returned by the iterator.

Method Summary

Public Methods
public

reset()

Resets this iterator result.

Public Constructors

public constructor(value: Object, done: Boolean) source

Constructs a new iterator result.

Params:

NameTypeAttributeDescription
value Object
  • optional
  • default: null

A value.

done Boolean
  • optional
  • default: false

Whether this result is past the end of the iterated sequence.

Public Members

public done: Boolean source

Whether this result is past the end of the iterated sequence.

public value: Object source

The value returned by the iterator.

Public Methods

public reset() source

Resets this iterator result.