Home > @rushstack/typings-generator > TypingsGenerator
TypingsGenerator class
This is a simple tool that generates .d.ts files for non-TS files.
Signature:
export declare class TypingsGenerator
Constructors
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(options) | Constructs a new instance of the TypingsGenerator class |
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| _options | protected | ITypingsGeneratorOptions | |
| ignoredFileGlobs | readonly | readonly string[] | The glob patterns that should be ignored when finding input files to process. |
| inputFileGlob | readonly | string | The glob pattern used to find input files to process. |
| sourceFolderPath | readonly | string | The folder path that contains all input source files. |
Methods
| Method | Modifiers | Description |
|---|---|---|
| generateTypingsAsync(relativeFilePaths) | Generate typings for the provided input files. | |
| getOutputFilePaths(relativePath) | ||
| registerDependency(consumer, rawDependency) | Register file dependencies that may effect the typings of a consumer file. Note: This feature is only useful in watch mode. The registerDependency method must be called in the body of parseAndGenerateTypings every time because the registry for a file is cleared at the beginning of processing. | |
| runWatcherAsync() |