Skip to content

extractInterfaceInfo

Extracts an interface’s model.

Import:

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

Signature:

function extractInterfaceInfo(iface: InterfaceDeclaration, namespace: string): TypeInfo

Parameters:

Parameter Type Description
iface InterfaceDeclaration The interface declaration.
namespace string The type’s namespace.

Returns: TypeInfo — The interface’s model.