isDocumentedFileName

Checks whether a source file is documented, judged by its name alone.

Excludes: *.test.ts (incl. *.browser.test.ts / *.integration.test.ts), *.d.ts, index.ts, __merged.ts, setup.ts and *-setup.ts.

Import:

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

Signature:

function isDocumentedFileName(name: string): boolean

Parameters:

Parameter	Type	Description
name	string	The file’s name.

Returns: boolean — Whether the file is documented.