Skip to content

Commit 7fb290d

Browse files
authored
docs(format/flutter): document className option for flutter/class.dart format (#1418)
Resolves #1417
1 parent 6cc1da3 commit 7fb290d

File tree

2 files changed

+2
-0
lines changed

2 files changed

+2
-0
lines changed

docs/src/content/docs/reference/Hooks/Formats/predefined.md

+1
Original file line numberDiff line numberDiff line change
@@ -1007,6 +1007,7 @@ Creates a Dart implementation file of a class with values
10071007
| -------------------------- | ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
10081008
| `options.showFileHeader` | `boolean` | Whether or not to include a comment that has the build date. Defaults to `true` |
10091009
| `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. |
1010+
| `options.className` | `string` | The name of the generated Dart Class |
10101011

10111012
Example:
10121013

lib/common/formats.js

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

0 commit comments

Comments
 (0)