traverse | @fal-works/s-l-t-r

Index

Type aliases

CallbackFunction

Functions

depthFirstSearch

Type aliases

CallbackFunction

CallbackFunction: (command: Command, depth: number) => boolean

Callback to be passed to depthFirstSearch(). Should return true to return command and stop traversing.

Type declaration

- (command: Command, depth: number): boolean
- Parameters
  - command: Command
  - depth: number
  Returns boolean

Functions

Const depthFirstSearch

depthFirstSearch(topCommand: Command, callback: CallbackFunction, currentDepth?: number): Command | undefined

- Defined in command/tools/traverse.ts:13
Runs callback for topCommand and all of its descendants in a depth-first order, until it finds any Command that matches the predicate.

Parameters
- topCommand: Command
- callback: CallbackFunction
- currentDepth: number = 0
Returns Command | undefined

Generated using TypeDoc