Skip to content

fix(theme): replace 'Call Signature' with the real signature in functions overload #187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
moshams272 wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

fix(theme): replace 'Call Signature' with the real signature in functions overload #187

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions plugins/shared/titles.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,13 +107,23 @@ export const getMemberPrefix = model => {
return prefix ? `${prefix}: ` : '';
};

export const getMemberTitle = (model, options) => {
export const getMemberTitle = (
model,
options,
specificSignature = null,
omitParams = false
) => {
const prefix = getMemberPrefix(model);
const params = model.parameters ?? callableSignatures(model)[0]?.parameters;
const name = escapeCode(memberName(model, options));

if (params) {
return `${prefix}\`${escapeCode(signatureExpression(model, params, name))}\``;
if (!omitParams) {
const params =
specificSignature?.parameters ??
model.parameters ??
callableSignatures(model)[0]?.parameters;
if (params) {
return `${prefix}\`${escapeCode(signatureExpression(model, params, name))}\``;
}
}

return `${prefix}\`${name}\``;
Expand Down
65 changes: 62 additions & 3 deletions plugins/theme/partials/index.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,51 @@ export default ctx => {
.join('\n');
},

signatures(model, options) {
const md = [];
const multipleSignatures =
model.signatures && model.signatures?.length > 1;

if (model.comment && multipleSignatures) {
md.push(
ctx.partials.comment(model.comment, {
headingLevel: options.headingLevel + 1,
})
);
}
if (multipleSignatures && model.documents) {
md.push(
ctx.partials.documents(model, {
headingLevel: options.headingLevel + 1,
})
);
}
model.signatures?.forEach(signature => {
if (multipleSignatures) {
md.push(
heading(
options.headingLevel + 1,
getMemberTitle(
model,
{ local: isTypePage(ctx.page.model) },
signature
)
)
);
}
md.push(
ctx.partials.signature(signature, {
headingLevel: multipleSignatures
? options.headingLevel + 2
: options.headingLevel + 1,
nested: options.nested,
multipleSignatures: false,
})
);
});
return md.join('\n\n');
},

declaration(model, options) {
const opts = { headingLevel: 2, nested: false, ...options };
const signatures = callableSignatures(model);
Expand Down Expand Up @@ -260,14 +305,23 @@ export default ctx => {
const multipleSignatures = model.signatures.length > 1;
model.signatures.forEach(signature => {
if (multipleSignatures) {
md.push(heading(options.headingLevel, i18n.kind_call_signature()));
md.push(
heading(
options.headingLevel,
getMemberTitle(
model,
{ local: isTypePage(ctx.page.model) },
signature
)
)
);
}
md.push(
ctx.partials.signature(signature, {
headingLevel: multipleSignatures
? options.headingLevel + 1
: options.headingLevel,
multipleSignatures,
multipleSignatures: false,
})
);
});
Expand Down Expand Up @@ -305,7 +359,12 @@ export default ctx => {
},

memberTitle: model =>
getMemberTitle(model, { local: isTypePage(ctx.page.model) }),
getMemberTitle(
model,
{ local: isTypePage(ctx.page.model) },
null,
model.signatures?.length > 1
),
parametersList(parameters) {
const flatList = [];

Expand Down
Loading