Class TreeContext

constructor

• new TreeContext(key, value, context, depth, breakEmitter, path, rootContext, changeEmitter): TreeContext

• Parameters

  • key: string | number

  • value: any

  • context: Record<string | number, any>

  • depth: number

  • breakEmitter: (() => void)

    • • (): void

      • Returns void

  • path: (string | number)[]

  • rootContext: Record<string | number, any>

  • changeEmitter: (() => void)

    • • (): void

      • Returns void

  Returns TreeContext

Readonly depth

Readonly path

const tree = {
  value: 1,
  depth: 0,
  left: {
    value: 2,
    depth: 1,
    left: { depth: 2, value: 4, left: null, right: null },
    right: { depth: 2, value: 5, left: null, right: null },
  },
  right: {
    value: 3,
    depth: 1,
    left: { depth: 2, value: 6, left: null, right: null },
    right: {
      depth: 2,
      value: 7, // <-- target
      left: null,
      right: null,
      UNIQUE_KEY: "UNIQUE_VALUE",
    },
  },
} as const;

let path: Readonly<(string | number)[]> | undefined
treeBFS(tree, (ctx) => {
  if (ctx.isRecord() && ctx.key === "value" && ctx.value === 7) {
    path = ctx.path;
  }
});

expect(path).toStrictEqual(["right", "right", "value"]);
Copy

ancestors

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

• Returns an array of ancestors of the current context. An ancestor is a parent or a grandparent of the current context. Each ancestor is represented as a record or an array.

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

  The array of ancestors.

children

• get children(): ObjectOrArray[]

• Returns an array of child objects or arrays in the tree context.

  Returns ObjectOrArray[]

  The child objects or arrays.

context

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

• Gets the current context.

  Mutating the context's structure may cause unexpected behavior.

  Returns any[] | Record<string, any>

  The current context, either as a record or an array.

key

• get key(): string | number

• Gets the key of the current context node.

  Returns string | number

  The key of the node.

parent

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

• Gets the parent context of the current node.

  Returns any[] | Record<string, any>

  The parent context.

rootContext

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

• Gets the root context of the tree.

  Returns Readonly<Record<string | number, any>>

  The root context.

value

• get value(): any

• Gets the value of the current context node.

  May cause unexpected behavior in traversal if mutated.

  Returns any

  The value of the node.
• set value(value): void

• Sets the value of the current context node.

  If the original value or the new value is an object, neither will be traversed through after setting a value.

  Parameters

  • value: any

    The new value to be set.

  Returns void

break

• break(): void

• Signals to break out of the tree traversal.

  Returns void

getOrThrowArrayContext

• getOrThrowArrayContext(): any[]

• Gets the current context as an array or throws an error if it's not an array.

  Returns any[]

  The context as an array.

  Throws

  Error if the context is not an array.

getOrThrowRecordContext

• getOrThrowRecordContext(): Record<string, any>

• Gets the current context as a record or throws an error if it's an array.

  Returns Record<string, any>

  The context as a record.

  Throws

  Error if the context is an array.

isArray

• isArray(): this is ArrayContext

• Checks if the current context is an array.

  Returns this is ArrayContext

  True if the context is an array, false otherwise.

isAtRoot

• isAtRoot(): boolean

• Checks if the current context is at the root of the tree.

  Returns boolean

  True if at the root, false otherwise.

isRecord

• isRecord(): this is RecordContext

• Checks if the current context is a record (not an array).

  Returns this is RecordContext

  True if the context is a record, false if it's an array.