CheckProjectTypesParams
Parameters for checkProjectTypes.
Import:
import type { CheckProjectTypesParams } from 'obsidian-dev-utils/script-utils/check-project-types';Signature:
export interface CheckProjectTypesParamsProperties
| Property | Type | Description |
|---|---|---|
| isVerbose? | boolean | When true, the ignored diagnostics (those dropped by CheckProjectTypesParams.shouldKeepFile or CheckProjectTypesParams.shouldKeepDiagnostic) are printed in full after the ignored count, so they can be inspected. When omitted or false, only the count is printed. |
| options | CompilerOptions | Compiler options for the program. skipLibCheck is always forced to false. |
| rootNames | readonly string[] | The root files to type-check. |
Methods
| Method | Returns | Description |
|---|---|---|
| shouldKeepDiagnostic(this, diagnostic) | boolean | Decides whether a diagnostic should be reported, based on the diagnostic itself rather than its source file. Runs in addition to CheckProjectTypesParams.shouldKeepFile — a diagnostic is reported only when both predicates keep it. Use this to drop diagnostics that are reported in a file we own but are caused by something we do not control (e.g. a cross-module-format interop complaint about a third-party import). When omitted, no diagnostic is dropped on this basis. |
| shouldKeepFile(this, fileName) | boolean | Decides whether a diagnostic's source file is one we care about. |
Links to this page: