typedoc-plugin-markdown
Version:
Generates TypeScript API documentation as Markdown.
25 lines (24 loc) • 1 kB
JavaScript
import { backTicks } from '../../../libs/markdown/index.js';
export function signatureParameters(model, options) {
const format = this.options.getValue('useCodeBlocks');
return ('(' +
model
.map((param) => {
const paramsmd = [];
if (param.flags?.isRest) {
paramsmd.push('...');
}
const paramType = this.partials.someType(param.type);
const showParamType = (options?.forceExpandParameters ?? false) ||
this.options.getValue('expandParameters');
const optional = param.flags.isOptional || param.defaultValue ? '?' : '';
const paramItem = [`${backTicks(`${param.name}${optional}`)}`];
if (showParamType) {
paramItem.push(paramType);
}
paramsmd.push(`${format && model.length > 2 ? `\n ` : ''}${paramItem.join(': ')}`);
return paramsmd.join('');
})
.join(`, `) +
')');
}