Skip to content

findDocsSnippetProblems

Type-checks every snippet of the guides.

Import:

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

Signature:

function findDocsSnippetProblems(params: FindDocsSnippetProblemsParams): Promise<DocsSnippetProblem[]>

Parameters:

Parameter Type Description
params FindDocsSnippetProblemsParams The FindDocsSnippetProblemsParams.

Returns: Promise<DocsSnippetProblem[]> — The problems found, empty when every snippet compiles.


Links to this page: