cargdev/angular
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore(doc-gen): include type parameters in d.ts file

Browse Source 
Closes #2859
This commit is contained in:
Peter Bacon Darwin
2015-07-03 14:49:00 +01:00
committed by Alex Eagle
parent e5405e4ba2
commit 72257ec87d
4 changed files with 55 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
docs/dgeni-package/processors/readTypeScriptModules.js
View File

@ -202,7 +202,22 @@ module.exports = function readTypeScriptModules(tsParser, readFilesProcessor, mo
location: getLocation(memberSymbol)
};
if (memberSymbol.flags & (ts.SymbolFlags.Method | ts.SymbolFlags.Signature)) {
memberDoc.typeParameters = getTypeParameters(typeChecker, memberSymbol);
if(memberSymbol.flags & (ts.SymbolFlags.Signature) ) {
memberDoc.parameters = getParameters(typeChecker, memberSymbol);
memberDoc.returnType = getReturnType(typeChecker, memberSymbol);
switch(memberDoc.name) {
case '__call':
memberDoc.name = '';
break;
case '__new':
memberDoc.name = 'new';
break;
}
}
if (memberSymbol.flags & ts.SymbolFlags.Method) {
// NOTE: we use the property name `parameters` here so we don't conflict
// with the `params` property that will be updated by dgeni reading the
// `@param` tags from the docs
@ -214,7 +229,7 @@ module.exports = function readTypeScriptModules(tsParser, readFilesProcessor, mo
memberDoc.name = 'constructor';
}
if(memberSymbol.flags & (ts.SymbolFlags.Value | ts.SymbolFlags.Signature) ) {
if(memberSymbol.flags & ts.SymbolFlags.Value) {
memberDoc.returnType = getReturnType(typeChecker, memberSymbol);
}
@ -248,6 +263,16 @@ module.exports = function readTypeScriptModules(tsParser, readFilesProcessor, mo
});
}
function getTypeParameters(typeChecker, symbol) {
var declaration = symbol.valueDeclaration || symbol.declarations[0];
var sourceFile = ts.getSourceFileOfNode(declaration);
if (!declaration.typeParameters) return;
var typeParams = declaration.typeParameters.map(function(type) {
return getText(sourceFile, type).trim();
});
return typeParams;
}
function getReturnType(typeChecker, symbol) {
var declaration = symbol.valueDeclaration || symbol.declarations[0];
var sourceFile = ts.getSourceFileOfNode(declaration);

10
docs/dgeni-package/processors/readTypeScriptModules.spec.js
View File

@ -67,12 +67,14 @@ describe('readTypeScriptModules', function() {
var moduleDoc = docs[0];
var exportedInterface = moduleDoc.exports[0];
expect(exportedInterface.callMember).toBeDefined();
expect(exportedInterface.callMember.parameters).toBeDefined();
expect(exportedInterface.callMember.returnType).toBeDefined();
expect(exportedInterface.callMember.parameters).toEqual(['param: T']);
expect(exportedInterface.callMember.returnType).toEqual('U');
expect(exportedInterface.callMember.typeParameters).toEqual(['T', 'U extends Findable<T>']);
expect(exportedInterface.newMember).toBeDefined();
expect(exportedInterface.newMember.parameters).toBeDefined();
expect(exportedInterface.newMember.returnType).toBeDefined();
expect(exportedInterface.newMember.parameters).toEqual(['param: number']);
expect(exportedInterface.newMember.returnType).toEqual('MyInterface');
});
});