maxmustermann/TypeScript
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Merge pull request #9303 from Microsoft/signatures-use-jsdoc-for-minArgumentCount

Browse source 
Signatures use JSDoc to determine optionality
This commit is contained in:
Nathan Shively-Sanders 2016-06-22 15:04:14 -07:00 committed by GitHub
parent 12bfb7e987 3a7396ea1c
commit 9134ed3b7d
5 changed files with 145 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/compiler/checker.ts
View file

@ -4401,7 +4401,7 @@ namespace ts {
return result;
}
function isOptionalParameter(node: ParameterDeclaration) {
function isJSDocOptionalParameter(node: ParameterDeclaration) {
if (node.flags & NodeFlags.JavaScriptFile) {
if (node.type && node.type.kind === SyntaxKind.JSDocOptionalType) {
return true;
@ -4418,8 +4418,10 @@ namespace ts {
}
}
}
}
if (hasQuestionToken(node)) {
function isOptionalParameter(node: ParameterDeclaration) {
if (hasQuestionToken(node) || isJSDocOptionalParameter(node)) {
return true;
}
@ -4486,7 +4488,7 @@ namespace ts {
hasStringLiterals = true;
}
if (param.initializer || param.questionToken || param.dotDotDotToken) {
if (param.initializer || param.questionToken || param.dotDotDotToken || isJSDocOptionalParameter(param)) {
if (minArgumentCount < 0) {
minArgumentCount = i - (hasThisParameter ? 1 : 0);
}

32
tests/baselines/reference/signaturesUseJSDocForOptionalParameters.js Normal file
View file

@ -0,0 +1,32 @@
//// [jsDocOptionality.js]
function MyClass() {
this.prop = null;
}
/**
* @param {string} required
* @param {string} [notRequired]
* @returns {MyClass}
*/
MyClass.prototype.optionalParam = function(required, notRequired) {
return this;
};
let pInst = new MyClass();
let c1 = pInst.optionalParam('hello')
let c2 = pInst.optionalParam('hello', null)
//// [out_1.js]
function MyClass() {
this.prop = null;
}
/**
* @param {string} required
* @param {string} [notRequired]
* @returns {MyClass}
*/
MyClass.prototype.optionalParam = function (required, notRequired) {
return this;
};
var pInst = new MyClass();
var c1 = pInst.optionalParam('hello');
var c2 = pInst.optionalParam('hello', null);

38
tests/baselines/reference/signaturesUseJSDocForOptionalParameters.symbols Normal file
View file

@ -0,0 +1,38 @@
=== tests/cases/compiler/jsDocOptionality.js ===
function MyClass() {
>MyClass : Symbol(MyClass, Decl(jsDocOptionality.js, 0, 0))
this.prop = null;
>prop : Symbol(MyClass.prop, Decl(jsDocOptionality.js, 0, 20))
}
/**
* @param {string} required
* @param {string} [notRequired]
* @returns {MyClass}
*/
MyClass.prototype.optionalParam = function(required, notRequired) {
>MyClass.prototype : Symbol(MyClass.optionalParam, Decl(jsDocOptionality.js, 2, 1))
>MyClass : Symbol(MyClass, Decl(jsDocOptionality.js, 0, 0))
>prototype : Symbol(Function.prototype, Decl(lib.d.ts, --, --))
>optionalParam : Symbol(MyClass.optionalParam, Decl(jsDocOptionality.js, 2, 1))
>required : Symbol(required, Decl(jsDocOptionality.js, 8, 43))
>notRequired : Symbol(notRequired, Decl(jsDocOptionality.js, 8, 52))
return this;
};
let pInst = new MyClass();
>pInst : Symbol(pInst, Decl(jsDocOptionality.js, 11, 3))
>MyClass : Symbol(MyClass, Decl(jsDocOptionality.js, 0, 0))
let c1 = pInst.optionalParam('hello')
>c1 : Symbol(c1, Decl(jsDocOptionality.js, 12, 3))
>pInst.optionalParam : Symbol(MyClass.optionalParam, Decl(jsDocOptionality.js, 2, 1))
>pInst : Symbol(pInst, Decl(jsDocOptionality.js, 11, 3))
>optionalParam : Symbol(MyClass.optionalParam, Decl(jsDocOptionality.js, 2, 1))
let c2 = pInst.optionalParam('hello', null)
>c2 : Symbol(c2, Decl(jsDocOptionality.js, 13, 3))
>pInst.optionalParam : Symbol(MyClass.optionalParam, Decl(jsDocOptionality.js, 2, 1))
>pInst : Symbol(pInst, Decl(jsDocOptionality.js, 11, 3))
>optionalParam : Symbol(MyClass.optionalParam, Decl(jsDocOptionality.js, 2, 1))

53
tests/baselines/reference/signaturesUseJSDocForOptionalParameters.types Normal file
View file

@ -0,0 +1,53 @@
=== tests/cases/compiler/jsDocOptionality.js ===
function MyClass() {
>MyClass : () => void
this.prop = null;
>this.prop = null : null
>this.prop : any
>this : any
>prop : any
>null : null
}
/**
* @param {string} required
* @param {string} [notRequired]
* @returns {MyClass}
*/
MyClass.prototype.optionalParam = function(required, notRequired) {
>MyClass.prototype.optionalParam = function(required, notRequired) { return this;} : (required: string, notRequired?: string) => { prop: null; optionalParam: any; }
>MyClass.prototype.optionalParam : any
>MyClass.prototype : any
>MyClass : () => void
>prototype : any
>optionalParam : any
>function(required, notRequired) { return this;} : (required: string, notRequired?: string) => { prop: null; optionalParam: any; }
>required : string
>notRequired : string
return this;
>this : { prop: null; optionalParam: (required: string, notRequired?: string) => { prop: null; optionalParam: any; }; }
};
let pInst = new MyClass();
>pInst : { prop: null; optionalParam: (required: string, notRequired?: string) => { prop: null; optionalParam: any; }; }
>new MyClass() : { prop: null; optionalParam: (required: string, notRequired?: string) => { prop: null; optionalParam: any; }; }
>MyClass : () => void
let c1 = pInst.optionalParam('hello')
>c1 : { prop: null; optionalParam: (required: string, notRequired?: string) => { prop: null; optionalParam: any; }; }
>pInst.optionalParam('hello') : { prop: null; optionalParam: (required: string, notRequired?: string) => { prop: null; optionalParam: any; }; }
>pInst.optionalParam : (required: string, notRequired?: string) => { prop: null; optionalParam: any; }
>pInst : { prop: null; optionalParam: (required: string, notRequired?: string) => { prop: null; optionalParam: any; }; }
>optionalParam : (required: string, notRequired?: string) => { prop: null; optionalParam: any; }
>'hello' : string
let c2 = pInst.optionalParam('hello', null)
>c2 : { prop: null; optionalParam: (required: string, notRequired?: string) => { prop: null; optionalParam: any; }; }
>pInst.optionalParam('hello', null) : { prop: null; optionalParam: (required: string, notRequired?: string) => { prop: null; optionalParam: any; }; }
>pInst.optionalParam : (required: string, notRequired?: string) => { prop: null; optionalParam: any; }
>pInst : { prop: null; optionalParam: (required: string, notRequired?: string) => { prop: null; optionalParam: any; }; }
>optionalParam : (required: string, notRequired?: string) => { prop: null; optionalParam: any; }
>'hello' : string
>null : null

17
tests/cases/compiler/signaturesUseJSDocForOptionalParameters.ts Normal file
View file

@ -0,0 +1,17 @@
// @allowJs: true
// @out: out_1.js
// @filename: jsDocOptionality.js
function MyClass() {
this.prop = null;
}
/**
* @param {string} required
* @param {string} [notRequired]
* @returns {MyClass}
*/
MyClass.prototype.optionalParam = function(required, notRequired) {
return this;
};
let pInst = new MyClass();
let c1 = pInst.optionalParam('hello')
let c2 = pInst.optionalParam('hello', null)