assertDocsSnippetsCompile

Type-checks every snippet of the guides and throws when one fails, for a docs:check-snippets script.

Import:

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

Signature:

function assertDocsSnippetsCompile(params: FindDocsSnippetProblemsParams): Promise<void>

Parameters:

Parameter	Type	Description
params	FindDocsSnippetProblemsParams	The AssertDocsSnippetsCompileParams.

Returns: Promise<void> — A promise that resolves when every snippet compiles.

---

Links to this page:

• AssertDocsSnippetsCompileParams