Skip to content

isDocumentedModulePath

Checks whether a module, given by its path relative to the source folder, has documentation pages.

Import:

import { isDocumentedModulePath } from '@mnaoumov/typescript-dev-toolkit/docs-site/api-doc-documented-files';

Signature:

function isDocumentedModulePath(modulePath: string): boolean

Parameters:

Parameter Type Description
modulePath string The POSIX path relative to the source folder, without its extension (linters/eslint).

Returns: boolean — Whether the generator documents that module.