Skip to content

Checker

Validates parsed documentation against the configured requirements.

9 exports Added in v0.6.0 Source

Validation

checkClasses

Added in v0.6.0 Source

Validates documentation for class declarations and their documented members.

Signature

declare function checkClasses(models: readonly Array<Class>): Effect<Array<string>, never, Configuration | Source>

checkConstants

Added in v0.6.0 Source

Validates documentation for constant declarations.

Signature

declare function checkConstants(models: readonly Array<Constant>): Effect<Array<string>, never, Configuration | Source>

checkExports

Added in v0.6.0 Source

Validates documentation for explicit export declarations.

Signature

declare function checkExports(models: readonly Array<Export>): Effect<Array<string>, never, Configuration | Source>

checkFunctions

Added in v0.6.0 Source

Validates documentation for function declarations.

Signature

declare function checkFunctions(models: readonly Array<Function>): Effect<Array<string>, never, Configuration | Source>

checkInterfaces

Added in v0.6.0 Source

Validates documentation for interface declarations.

Signature

declare function checkInterfaces(models: readonly Array<Interface>): Effect<Array<string>, never, Configuration | Source>

checkModule

Added in v0.6.0 Source

Validates every documented declaration in a parsed module.

Signature

declare function checkModule(module: Module): Effect<Array<string>, never, Configuration>;

checkModules

Added in v0.6.0 Source

Validates every documented declaration in a collection of parsed modules.

Signature

declare function checkModules(modules: readonly Array<Module>): Effect<Array<string>, never, Configuration>

checkNamespaces

Added in v0.6.0 Source

Validates documentation for namespaces and their nested declarations.

Signature

declare function checkNamespaces(models: readonly Array<Namespace>): Effect<Array<string>, never, Configuration | Source>

checkTypeAliases

Added in v0.6.0 Source

Validates documentation for type alias declarations.

Signature

declare function checkTypeAliases(models: readonly Array<TypeAlias>): Effect<Array<string>, never, Configuration | Source>