added info regarding typeBlacklist and typeWhitelist

jburzynski · Aug 25, 2023 · bc51f6f · bc51f6f
1 parent 4ce884d
commit bc51f6f
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/source/cli.rst b/source/cli.rst
@@ -122,12 +122,16 @@ singleQuotes                           boolean             false
 
 tabLength                              number              4                                      The number of spaces per tab in the generated TypeScript files.
 
+typeBlacklist                          string[]            []                                     Types that should not be generated (specified by name or full name). Apart from the specified types, the following default types are also added to typeBlacklist: IAsyncDisposable, ICloneable, IComparable, IConvertible, IDisposable, IEquatable, IFormattable, IParsable, ISerializable, ISpanFormattable, ISpanParsable, ValueType (and their generic variants where applicable). Types can be removed from typeBlacklist by using typeWhitelist.
+
 typeNameConverters (*)                 string[]            []                                     Converter chain used for converting C# type names to TypeScript type names. See the (*) explanation below regarding ways in which class names can be specified.
 
 typeScriptFileExtension                string              "ts"                                   File extension for the generated TypeScript files.
 
 typeUnionsForTypes                     Object              {}                                     Object containing a map of [TypeScript type -> type unions] mappings (example below).
 
+typeWhitelist                          string[]            []                                     Removes types from typeBlacklist. Types can be specified by name or full name.
+
 useDefaultExport                       boolean             false                                  Whether to use TypeScript default exports by default.
 
 useImportType                          boolean             false                                  Whether to use "import type" instead of "import" in the generated TypeScript sources.