docs(format/flutter): document className option for flutter/class.dar…

…t format Resolves #1417
amzn · Dec 17, 2024 · 7b2f442 · 7b2f442
1 parent 737a02b
commit 7b2f442
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/docs/src/content/docs/reference/Hooks/Formats/predefined.md b/docs/src/content/docs/reference/Hooks/Formats/predefined.md
@@ -1007,6 +1007,7 @@ Creates a Dart implementation file of a class with values
 | -------------------------- | ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `options.showFileHeader`   | `boolean`                             | Whether or not to include a comment that has the build date. Defaults to `true`                                                                                                                                                    |
 | `options.outputReferences` | `boolean \| OutputReferencesFunction` | Whether or not to keep [references](/reference/hooks/formats#references-in-output-files) (a -> b -> c) in the output. Defaults to `false`. Also allows passing a function to conditionally output references on a per token basis. |
+| `options.className`        | `string`                              | The name of the generated Dart Class                                                                                                                                                                                               |
 
 Example:
 

diff --git a/lib/common/formats.js b/lib/common/formats.js
@@ -1655,6 +1655,7 @@ declare const ${moduleName}: ${JSON.stringify(treeWalker(dictionary.tokens), nul
    * @typedef {Object} flutterClassOpts
    * @property {boolean} [flutterClassOpts.showFileHeader=true] - Whether or not to include a comment that has the build date
    * @property {OutputReferences} [flutterClassOpts.outputReferences=false] - Whether or not to keep [references](/#/formats?id=references-in-output-files) (a -> b -> c) in the output.
+   * @property {String} [flutterClassOpts.className] - The name of the generated Dart Class
    * @param {FormatArgs & { options?: flutterClassOpts }} options
    * @example
    * ```dart