Skip to content

isDocumentedDirectoryName

Checks whether a directory’s subtree is documented.

Import:

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

Signature:

function isDocumentedDirectoryName(name: string): boolean

Parameters:

Parameter Type Description
name string The directory’s name.

Returns: boolean — false for a @types, styles or test-helpers directory.