Options
All
  • Public
  • Public/Protected
  • All
Menu

Iterator class for objects returned by getObjectPermutations.

Type parameters

  • T: object

Hierarchy

  • ObjectPermutationsIterator

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

done

done: boolean

Flag is set to true when the final permutation was consumed by the iteration.

indices

indices: number[]

Initialized to store a list of indices pinpointing the iterator's present location in the full list of permutations

keys

keys: keyof T[]

Initialized to store a list of the state object's valid keys.

length

length: number

Initialized to represent the full length of the iterator. This length value may be inaccurate if the total number of permutations exceeds the value of Number.MAX_SAFE_INTEGER.

states

states: T

The input object describing all state permutations.

Methods

array

  • Get an array containing the remaining values of this iterator.

    Returns ObjectPermutation<T>[]

    an array of permutation objects.

next

  • Get the next permutation.

    Returns IteratorResult<ObjectPermutation<T>>

    an IteratorResult whose value attribute, when the done attribute was not true, is a permutation object.

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