FindDocsSnippetProblemsParams

Parameters for findDocsSnippetProblems.

Import:

import type { FindDocsSnippetProblemsParams } from '@mnaoumov/typescript-dev-toolkit/docs-site/docs-snippets';

Signature:

export interface FindDocsSnippetProblemsParams

Properties

Property	Type	Description
compilerOptions?	CompilerOptions	Compiler options laid over the ones tsconfig.json gives, for instance paths that resolve the package's own name onto its sources when its tsconfig.json has none. A relative path in them is not resolved, so pass absolute ones.
docsDirectory?	string	The guides directory, relative to FindDocsSnippetProblemsParams.rootDirectory.
prelude?	string	The ambient context every snippet is compiled with: the names a guide may use without declaring them, written as a module (declare global { ... }, with the imports it needs).
rootDirectory	string	The package root, holding tsconfig.json.

---

Links to this page:

• assertDocsSnippetsCompile
• AssertDocsSnippetsCompileParams
• findDocsSnippetProblems