Skip to content

keepPublicApi

Drops every documented type the public API barrel does not re-export. Run it after resolveInheritedMembers, so a public class still inherits the members of an internal base class.

Import:

import { keepPublicApi } from '@mnaoumov/typescript-dev-toolkit/docs-site/api-doc-source-processing';

Signature:

function keepPublicApi(types: Map<string, TypeInfo>, barrel: PublicApiBarrel): void

Parameters:

Parameter Type Description
types Map<string, TypeInfo> The documented types, keyed by qualified id.
barrel PublicApiBarrel The barrel, read by readPublicApiBarrel.

Returns: void