Options

Pass options as the last argument (for example t.forEach(obj, cb, { maxDepth: 100 })). t.map and t.mapAsync always run immutably; other ops default to in-place mutation unless you set immutable: true.

{
  immutable: false,           // if true, never mutate the original object
  includeSymbols: false,      // if true, also traverse own enumerable symbol keys
  maxDepth: undefined,        // bound recursion depth (throws RangeError when exceeded)
  signal: undefined,          // AbortSignal, cancels forEachAsync()/mapAsync()
  descendIntoMapSet: false,   // if true, visit Map/Set entries during walks (see Iteration)
  concurrency: 1,             // parallel sibling callbacks in forEachAsync/mapAsync (see Async)
}

See also Security (maxDepth DoS guard) and Types & traversal (includeSymbols, descendIntoMapSet).

Example

import * as t from 'neotraverse';

t.forEach(
  untrusted,
  (ctx, x) => {
    /* … */
  },
  {
    maxDepth: 500,
    includeSymbols: false,
    immutable: true
  }
);