foundation-utils.visitobject

Home > @genesislcap/foundation-utils > visitObject

visitObject() function

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Visit object utility.

Signature:

export declare function visitObject<TVisitorData>(object: any, deep: boolean, visitor: ObjectVisitor<TVisitorData>, data: TVisitorData, traversed: WeakSet<any> | Set<any>): void;

Parameters

Parameter	Type	Description
object	any	The object.
deep	boolean	A flag to indicate if a recursive visit of sub objects should occur.
visitor	ObjectVisitor<TVisitorData>	The defined ObjectVisitor logic.
data	TVisitorData	Visitor data.
traversed	WeakSet<any> | Set<any>	The traversed object set.

Returns:

void

Example

Reactive example.

export function reactive<T>(object: T, deep = false): T {
  visitObject(object, deep, makeObserverVisitor, void 0, observed);
  return object;
}