Function signatureParametersToMarkdownTable

packages/lsp/src/server/hover.ts:214–245

(signatures: SignatureDefinition[])

}

function signatureParametersToMarkdownTable(signatures: SignatureDefinition[]): string {
    if (signatures.length === 0 || (signatures.length === 1 && signatures[0].parameters.length === 0)) {
        return '';
    }

    const hasOverloads = signatures.length > 1;
    if (hasOverloads) {
        return [
            '',
            '**Parameters:**',
            '| Overload | Name | Description | Type | Required |',
            '|----------|------|-------------|------|----------|',
            ...signatures.flatMap((s, si) =>
                s.parameters.map(v => {
                    return `| \`[${si + 1}]\` | \`${v.name}\` | ${(v.longDescription ?? v.shortDescription)?.replaceAll('\n', '<br />') ?? ''} | \`${nodeTypesToSyntax(v).replaceAll('|', '\\|')}\` | ${isRequiredParameter(v.parseMode) ? 'yes' : 'no'} ${v.defaultValue ?? ''} |`;
                })
            )
        ].join('\n');
    } else {
        return [
            '',
            '**Parameters:**',
            '| Name | Description | Type | Required |',
            '|------|-------------|------|----------|',
            ...signatures.flatMap(s =>
                s.parameters.map(v => {
                    return `| \`${v.name}\` | ${(v.longDescription ?? v.shortDescription)?.replaceAll('\n', '<br />') ?? ''} | \`${nodeTypesToSyntax(v).replaceAll('|', '\\|')}\` | ${isRequiredParameter(v.parseMode) ? 'yes' : 'no'} ${v.defaultValue ?? ''} |`;
                })
            )
        ].join('\n');
    }
}

function parameterValueDocsToMarkDown(docs: ParameterValueDefinition): string {
    return [`## ${docs.name}`, docs.longDescription ?? docs.shortDescription, ''].join('\n');