Function getTypesFromFolder

Inspect typescript source code for types and return a report.

getTypesFromFolder(
options: GetTypesAsMermaidOption & { typeNameForMermaid: string },
): TypeReport & { mermaid: string }
Parameters
- options: GetTypesAsMermaidOption & { typeNameForMermaid: string }
Returns TypeReport & { mermaid: string }
- Defined in src/documentation/doc-util/doc-types.ts:484
getTypesFromFolder(
options: GetTypesAsMermaidOption & { typeNameForMermaid?: undefined },
): TypeReport & { mermaid: undefined }
Parameters
- options: GetTypesAsMermaidOption & { typeNameForMermaid?: undefined }
Returns TypeReport & { mermaid: undefined }
- Defined in src/documentation/doc-util/doc-types.ts:485
getTypesFromFolder(options: GetTypesAsMermaidOption): TypeReport
Parameters
- options: GetTypesAsMermaidOption
Returns TypeReport
- Defined in src/documentation/doc-util/doc-types.ts:486