Class ObjectTraversalContext

constructor

• new ObjectTraversalContext(__namedParameters): ObjectTraversalContext

• Parameters

  • __namedParameters: Required<TreeContextConstructor<any[] | Record<string, any>, any[] | Record<string, any>, (string | number)[]>>

  Returns ObjectTraversalContext

Readonly depth

Readonly path

ancestors

• get ancestors(): (any[] | Record<string, any>)[]

• Returns (any[] | Record<string, any>)[]

children

• get children(): ObjectOrArray[]

• Returns ObjectOrArray[]

context

• get context(): any[] | Record<string, any>

• Returns any[] | Record<string, any>

parent

• get parent(): undefined | any[] | Record<string, any>

• Returns undefined | any[] | Record<string, any>

rootContext

• get rootContext(): Readonly<any[] | Record<string, any>>

• Returns Readonly<any[] | Record<string, any>>

break

• break(): void

• Returns void

getOrThrowArrayContext

• getOrThrowArrayContext(): any[]

• Returns any[]

getOrThrowRecordContext

• getOrThrowRecordContext(): Record<string, any>

• Returns Record<string, any>

isArray

• isArray(): this is ArrayMutatingContext

• Returns this is ArrayMutatingContext

isAtRoot

• isAtRoot(): boolean

• Returns boolean

isRecord

• isRecord(): this is RecordMutatingContext

• Returns this is RecordMutatingContext

merge

• merge(newContext, removeExisting?): "CONTEXT_MERGED" | "NOT_CONTEXT_OR_ARRAY"

• Merges the provided context with the current context.

  Parameters

  • newContext: ObjectOrArray

    The new context to merge.

  • removeExisting: boolean = false

    Optional. Specifies whether to remove existing values in the current context. Default is false.

  Returns "CONTEXT_MERGED" | "NOT_CONTEXT_OR_ARRAY"

  The status of the context merge operation.

replace

• replace(value): "CONTEXT_REPLACED" | "ALREADY_AT_ROOT_OR_EMPTY_PATH" | "INVALID_INDEX_TYPE_FOR_ARRAY"

• Replaces the value at the current path with the specified value. If the current context is already at the root or an empty path, it returns treeUpdateStatus.ALREADY_AT_ROOT_OR_EMPTY_PATH. If the parent is an array and the last path element is not a valid index, it returns treeUpdateStatus.INVALID_INDEX_TYPE_FOR_ARRAY. Otherwise, it replaces the value at the current path and returns treeUpdateStatus.CONTEXT_REPLACED.

  Parameters

  • value: null | {}

    The value to replace with.

  Returns "CONTEXT_REPLACED" | "ALREADY_AT_ROOT_OR_EMPTY_PATH" | "INVALID_INDEX_TYPE_FOR_ARRAY"

  The status of the tree update operation.