typedoc-plugin-markdown/dist/theme/context/partials/type.reflection.declaration.js

A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.

import { backTicks } from '../../../libs/markdown/index.js';
export function declarationType(model, options) {
    const shouldFormat = this.options.getValue('useCodeBlocks');
    const md = ['\\{'];
    if (model.indexSignatures?.length) {
        const indexSignatureMd = [];
        model.indexSignatures.forEach((indexSignature) => {
            const key = indexSignature.parameters
                ? indexSignature.parameters.map((param) => `\\[${backTicks(param.name)}: ${this.partials.someType(param.type)}\\]`)
                : '';
            const obj = this.partials.someType(indexSignature.type);
            indexSignatureMd.push(`${key}: ${obj};`);
        });
        md.push(indexSignatureMd.join('\n'));
    }
    if (model.signatures) {
        md.push(`${this.partials.functionType(model.signatures, { typeSeparator: ': ' })};`);
    }
    if (model.children) {
        const children = model.children;
        const declarationTypes = children &&
            children.map((obj) => {
                const name = [];
                if (obj.getSignature) {
                    name.push('get');
                    name.push(backTicks(obj.name) + '()');
                }
                else if (obj.setSignature) {
                    name.push('set');
                    const params = obj.setSignature.parameters
                        ? this.partials.signatureParameters(obj.setSignature.parameters, {
                            forceExpandParameters: true,
                        })
                        : '()';
                    name.push(backTicks(obj.name) + params);
                }
                else {
                    const displayObjectName = obj.name + (obj.flags?.isOptional ? '?' : '');
                    name.push(backTicks(displayObjectName));
                }
                const theType = this.helpers.getDeclarationType(obj);
                const typeString = this.partials.someType(theType, options);
                if (shouldFormat) {
                    return `  ${name.join(' ')}: ${indentBlock(typeString)};`;
                }
                return `${name.join(' ')}: ${indentBlock(typeString)};`;
            });
        if (declarationTypes) {
            md.push(`${shouldFormat ? `${declarationTypes.join('\n')}` : ` ${declarationTypes.join(' ')}`}`);
        }
    }
    md.push(`${shouldFormat ? '' : ' '}\\}`);
    return md.join(shouldFormat ? '\n' : '');
}
function indentBlock(content) {
    const lines = content.split(`${'\n'}`);
    return lines
        .filter((line) => Boolean(line.length))
        .map((line, i) => {
        if (i === 0) {
            return line;
        }
        if (i === lines.length - 1) {
            return line.trim().startsWith('}') ? line : `  ${line}`;
        }
        return `   ${line}`;
    })
        .join(`${`\n`}`);
}