typedoc-plugin-markdown/dist/theme/context/helpers/has-useful-type-details.js

A TypeDoc plugin that generates TypeScript API documentation as Markdown.

export function hasUsefulTypeDetails(type) {
    return type.visit(isUsefulVisitor) ?? false;
}
// Adapted from TypeDoc's default theme. TypeDoc also treats `@expand` and
// highlighted-property references as useful because its theme renders their
// members inline; this theme does not, so counting them would leave the type
// with no output at all.
const isUsefulVisitor = {
    array(type) {
        return hasUsefulTypeDetails(type.elementType);
    },
    intersection(type) {
        return type.types.some(hasUsefulTypeDetails);
    },
    union(type) {
        return !!type.elementSummaries || type.types.some(hasUsefulTypeDetails);
    },
    reflection(type) {
        return renderingChildIsUseful(type.declaration);
    },
};
function renderingChildIsUseful(refl) {
    if (renderingThisChildIsUseful(refl)) {
        return true;
    }
    return refl.getProperties().some(renderingThisChildIsUseful);
}
function renderingThisChildIsUseful(refl) {
    if (refl.hasComment())
        return true;
    const declaration = refl.type?.type === 'reflection' ? refl.type.declaration : refl;
    if (declaration.hasComment())
        return true;
    return declaration.getAllSignatures().some((sig) => {
        return sig.hasComment() || sig.parameters?.some((p) => p.hasComment());
    });
}