Rush StackShopBlogEvents
Skip to main content

Home > @rushstack/localization-utilities > ITypingsGeneratorOptions

ITypingsGeneratorOptions interface

Signature:

export interface ITypingsGeneratorOptions extends ITypingsGeneratorBaseOptions 

Extends: ITypingsGeneratorBaseOptions

Properties

Property

Modifiers

Type

Description

exportAsDefault?

boolean | IExportAsDefaultOptions | IInferInterfaceNameExportAsDefaultOptions

(Optional) Options for configuring the default export.

ignoreMissingResxComments?

boolean | undefined

(Optional) If true, .resx files will not throw errors if comments are missing.

ignoreString?

IgnoreStringFunction

(Optional) Optionally, provide a function that will be called for each string. If the function returns true the string will not be included.

processComment?

(comment: string | undefined, relativeFilePath: string, stringName: string) => string | undefined

(Optional) Processes the raw text of a comment.

resxNewlineNormalization?

NewlineKind | undefined

(Optional) Normalizes the line endings in .resx files to the specified kind.

trimmedJsonOutputFolders?

string[] | undefined

(Optional) If specified, the generator will write trimmed .json files to the specified folders. The .json files will be written to the same relative path as the source file. For example, if the source file is "<root>/foo/bar.resx", and the output folder is "dist", the trimmed .json file will be written to "dist/foo/bar.resx.json".