Skip to content

extractTypeAliasInfo

Extracts a type alias’s model.

Import:

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

Signature:

function extractTypeAliasInfo(alias: TypeAliasDeclaration, namespace: string): TypeInfo

Parameters:

Parameter Type Description
alias TypeAliasDeclaration The type alias declaration.
namespace string The type’s namespace.

Returns: TypeInfo — The type alias’s model.