Skip to content

extractEnumInfo

Extracts an enum’s model.

Import:

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

Signature:

function extractEnumInfo(enumDeclaration: EnumDeclaration, namespace: string): TypeInfo

Parameters:

Parameter Type Description
enumDeclaration EnumDeclaration The enum declaration.
namespace string The type’s namespace.

Returns: TypeInfo — The enum’s model.