Skip to content

extractClassInfo

Extracts a class’s model: its constructor, non-private properties and methods, and documentation.

Import:

import { extractClassInfo } from '@mnaoumov/typescript-dev-toolkit/docs-site/api-doc-jsdoc';

Signature:

function extractClassInfo(cls: ClassDeclaration, namespace: string): TypeInfo

Parameters:

Parameter Type Description
cls ClassDeclaration The class declaration.
namespace string The type’s namespace.

Returns: TypeInfo — The class’s model.