Elgato_dark/angular
1
0
Fork 0
mirror of https://github.com/angular/angular synced 2026-05-24 09:28:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

refactor(compiler-cli): Extract call signatures from interfaces. (#56973)

Browse source 
This commit adds support for extracting call signals from interfaces.

fixes #56969

PR Close #56973
This commit is contained in:
Matthieu Riegler 2024-07-13 00:23:32 +02:00 committed by Andrew Scott
parent 5c08ae68ad
commit 634d55a4f6
2 changed files with 32 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
packages/compiler-cli/src/ngtsc/docs/src/class_extractor.ts
View file

@ -272,7 +272,8 @@ class ClassExtractor {
return (
!member.name ||
!this.isDocumentableMember(member) ||
!!member.modifiers?.some((mod) => mod.kind === ts.SyntaxKind.PrivateKeyword) ||
(!ts.isCallSignatureDeclaration(member) &&
member.modifiers?.some((mod) => mod.kind === ts.SyntaxKind.PrivateKeyword)) ||
member.name.getText() === 'prototype' ||
isAngularPrivateName(member.name.getText()) ||
isInternal(member)
@ -280,8 +281,16 @@ class ClassExtractor {
}
/** Gets whether a class member is a method, property, or accessor. */
private isDocumentableMember(member: ts.Node): member is MethodLike | PropertyLike {
return this.isMethod(member) || this.isProperty(member) || ts.isAccessor(member);
private isDocumentableMember(
member: ts.Node,
): member is MethodLike | PropertyLike | ts.CallSignatureDeclaration {
return (
this.isMethod(member) ||
this.isProperty(member) ||
ts.isAccessor(member) ||
// Signatures are documentable if they are part of an interface.
ts.isCallSignatureDeclaration(member)
);
}
/** Gets whether a member is a property. */

20
packages/compiler-cli/test/ngtsc/doc_extraction/interface_doc_extraction_spec.ts
View file

@ -76,6 +76,26 @@ runInEachFileSystem(() => {
expect(propertyEntry.type).toBe('number');
});
it('should extract call signatures', () => {
env.write(
'index.ts',
`
export interface UserProfile {
(name: string): string;
}
`,
);
const docs: DocEntry[] = env.driveDocsExtraction('index.ts');
const interfaceEntry = docs[0] as InterfaceEntry;
expect(interfaceEntry.members.length).toBe(1);
const methodEntry = interfaceEntry.members[0] as MethodEntry;
expect(methodEntry.memberType).toBe(MemberType.Method);
expect(methodEntry.name).toBe('');
expect(methodEntry.returnType).toBe('string');
});
it('should extract a method with a rest parameter', () => {
env.write(
'index.ts',