Type Alias Callback<P, K, V, R>

Callback: (
    this: Snapshot<R, K, V, P>,
    child: ChildContext<P, K, V>,
    parent: Readonly<ParentContext<P, K>>,
    control: Control,
) => unknown

Callback for deepIterate.

This is executed on each node before iterating over it.

Notes:

The return value is neither saved nor used.
A synchronous callback is expected.

Type Parameters

P extends object
K = unknown
V = unknown
R extends P = any

Type Declaration

- (
      this: Snapshot<R, K, V, P>,
      child: ChildContext<P, K, V>,
      parent: Readonly<ParentContext<P, K>>,
      control: Control,
  ): unknown
- Parameters
  - this: Snapshot<R, K, V, P>
    Includes the received arguments, and opcionally, a visit log.
  - child: ChildContext<P, K, V>
    Information about the current child.
  - parent: Readonly<ParentContext<P, K>>
    Information about the current parent.
  - control: Control
    Controls iteration behavior for the node and its parent.
  Returns unknown
  Any value.

Since

3.0.0-beta.3