Skip to content

Commit

Permalink
docs: more comment fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
isaacs committed May 27, 2024
1 parent 5de3680 commit e08023d
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,9 +142,11 @@ const results = await graphRun/*<Node, Result>*/({
// optional: if this method throws, then the traversal will
// of course fail when cycles are encountered. If not provided,
// then cycles are silently detected and skipped.
// first argument is the array of nodes forming a cycle,
// second argument is the path taken to get to the cycle entry
// (node: Node[], cycle: Node[], path: Node[]) => void | Promise<void>
// first argument is the dependency that would cause a cycle
// second argument is the cycle from that node back to itself
// third is the path to the dependent that wanted to load it,
// but instead will skip it because of the cycle.
// (node: Node, cycle: Node[], path: Node[]) => void | Promise<void>
onCycle: (node, cycle, path) => {
console.error(
`warning: while evaluating ${
Expand Down

0 comments on commit e08023d

Please sign in to comment.