docs(rule-tester): Document [DATA] methods in FlatRuleTester

luca-script · luca-script · commit d1b5b9e6f88c · 2024-06-11T09:59:52.000+02:00
diff --git a/packages/rule-tester/src/FlatRuleTester.ts b/packages/rule-tester/src/FlatRuleTester.ts
@@ -520,7 +520,10 @@ export class FlatRuleConfig<
       );
     });
   }
-
+  /**
+   * Gets all configurations and the associated rule from a rule instance
+   * Is a symbol to prevent cluttering up available methods
+   */
   [DATA](): {
     configurations: FlatRuleConfiguration<MessageIds, Options>[];
     rule: RuleModule<MessageIds, Options>;
@@ -585,6 +588,10 @@ export class FlatRuleConfiguration<
     return this;
   }
 
+  /**
+   * Gets all samples and configuration from a configuration instance
+   * Is a symbol to prevent cluttering up available methods
+   */
   [DATA](): {
     valid: ValidSample[];
     invalid: InvalidSample<MessageIds>[];
