Class ObjectIterator<T>

Iterates through all keys in an object. Optionally provides traversal order. Does not support circular references and will throw a RangeError with max call stack exceeded.

Todo

// TODO: Add support for BFS traversal order.

Type Parameters

T extends Record<PropertyKey, any>

Implements

IterableIterator<ObjectEntry>

Index

Constructors

Properties

arr inner traversal

Methods

[iterator] isObject next push

Constructors

constructor

new ObjectIterator<T>(object, traversal?): ObjectIterator<T>
Type Parameters
- T extends Record<PropertyKey, any>
Parameters
- object: T
- traversal: "post-order-DFS" | "pre-order-DFS" | "BFS" = 'post-order-DFS'
Returns ObjectIterator<T>
- Defined in internal/ObjectIterator.ts:14

Properties

`Protected`arr

arr: ObjectEntry[] = []

`Protected`inner

inner: null | Iterator<ObjectEntry, any, any> = null

`Protected`traversal

traversal: "post-order-DFS" | "pre-order-DFS" | "BFS" = 'post-order-DFS'

Methods

[iterator]

[iterator](): IterableIterator<ObjectEntry, any, any>
Returns IterableIterator<ObjectEntry, any, any>
Implementation of IterableIterator.[iterator]
- Defined in internal/ObjectIterator.ts:21

`Protected`isObject

isObject(value): value is object
Parameters
- value: any
Returns value is object
- Defined in internal/ObjectIterator.ts:45

next

next(...args): IteratorResult<ObjectEntry, any>
Parameters
- Rest...args: any[]
Returns IteratorResult<ObjectEntry, any>
Implementation of IterableIterator.next
- Defined in internal/ObjectIterator.ts:25

`Protected`push

push(obj): void
Parameters
- obj: any
Returns void
- Defined in internal/ObjectIterator.ts:49