docs: document recoveredNode property on CST Nodes

Chevrotain · Apr 11, 2020 · 09afb8d · 09afb8d
1 parent 765938c
commit 09afb8d
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/packages/chevrotain/api.d.ts b/packages/chevrotain/api.d.ts
@@ -1930,6 +1930,15 @@ export interface ICstVisitor<IN, OUT> {
 export interface CstNode {
   readonly name: string
   readonly children: CstChildrenDictionary
+  /**
+   * A flag indicating the whole CSTNode has been recovered during **re-sync** error recovery.
+   * This means that some of the node's children may be missing.
+   * - Note that single token insertion/deletion recovery would not activate this flag.
+   *   This flag would only be activated in **re-sync** recovery when the rule's
+   *   grammar cannot be fully parsed.
+   * - See: https://sap.github.io/chevrotain/docs/tutorial/step4_fault_tolerance.html
+   *   for more info on error recovery and fault tolerance.
+   */
   readonly recoveredNode?: boolean
 
   /**