22919d57fe
* JSDoc:positional matching of destructured params 1. When looking up tags for a parameter whose name is a binding pattern, use the index of the parameter to get the type. 2. When reporting errors for `@param` tags with no matching parameter name, do not report the error for tags whose index in the `@param` tag list matches the index of a parameter whose name is a binding pattern. * Change to an assert * Improve comment text
72 lines
1.6 KiB
TypeScript
72 lines
1.6 KiB
TypeScript
// @allowJS: true
|
|
// @checkJS: true
|
|
// @noEmit: true
|
|
// @Filename: 0.js
|
|
|
|
// Object literal syntax
|
|
/**
|
|
* @param {{a: string, b: string}} obj
|
|
* @param {string} x
|
|
*/
|
|
function good1({a, b}, x) {}
|
|
/**
|
|
* @param {{a: string, b: string}} obj
|
|
* @param {{c: number, d: number}} OBJECTION
|
|
*/
|
|
function good2({a, b}, {c, d}) {}
|
|
/**
|
|
* @param {number} x
|
|
* @param {{a: string, b: string}} obj
|
|
* @param {string} y
|
|
*/
|
|
function good3(x, {a, b}, y) {}
|
|
/**
|
|
* @param {{a: string, b: string}} obj
|
|
*/
|
|
function good4({a, b}) {}
|
|
|
|
// nested object syntax
|
|
/**
|
|
* @param {Object} obj
|
|
* @param {string} obj.a - this is like the saddest way to specify a type
|
|
* @param {string} obj.b - but it sure does allow a lot of documentation
|
|
* @param {string} x
|
|
*/
|
|
function good5({a, b}, x) {}
|
|
/**
|
|
* @param {Object} obj
|
|
* @param {string} obj.a
|
|
* @param {string} obj.b - but it sure does allow a lot of documentation
|
|
* @param {Object} OBJECTION - documentation here too
|
|
* @param {string} OBJECTION.c
|
|
* @param {string} OBJECTION.d - meh
|
|
*/
|
|
function good6({a, b}, {c, d}) {}
|
|
/**
|
|
* @param {number} x
|
|
* @param {Object} obj
|
|
* @param {string} obj.a
|
|
* @param {string} obj.b
|
|
* @param {string} y
|
|
*/
|
|
function good7(x, {a, b}, y) {}
|
|
/**
|
|
* @param {Object} obj
|
|
* @param {string} obj.a
|
|
* @param {string} obj.b
|
|
*/
|
|
function good8({a, b}) {}
|
|
|
|
/**
|
|
* @param {object} obj - this type gets ignored
|
|
* @param {string} obj.a
|
|
* @param {string} obj.b - and x's type gets used for both parameters
|
|
* @param {string} x
|
|
*/
|
|
function bad1(x, {a, b}) {}
|
|
/**
|
|
* @param {string} y - here, y's type gets ignored but obj's is fine
|
|
* @param {{a: string, b: string}} obj
|
|
*/
|
|
function bad2(x, {a, b}) {}
|