react-fiber-traverse/docs/modules/_traverse_.md

react-fiber-traverse

Globals / "traverse" /

External module: "traverse"

Index

Functions

• traverse
• traverseGenerator

Functions

traverse

▸ traverse(node: FiberNode, fn: function): void

Defined in traverse.ts:19

Traverse nodes recursively in depth-first manner, starting from a start node.

This is the default and basic traversal method, which covers basic use cases. You can't do advanced things like change the order of traversal, skip or cancel traversal after any node, etc. For more advanced usecases, see traverseGenerator

example

// calls fn for each node inside startNode
traverse(startNode, fn);

Parameters:

▪ node: FiberNode

▪ fn: function

▸ (node: FiberNode): any

Parameters:

Name	Type
node	FiberNode

Returns: void

---

traverseGenerator

▸ traverseGenerator(node: FiberNode, __namedParameters: object): IterableIterator<FiberNode>

Defined in traverse.ts:30

Parameters:

▪ node: FiberNode

▪Default value __namedParameters: object= {}

Name	Type	Default
order	"self" | "child" | "sibling"[]	["self", "child", "sibling"]

Returns: IterableIterator<FiberNode>