TypeScript/tests/baselines/reference/signatureHelpJSMissingPropertyAccess.baseline
Sang a354a77030
Improve rendering of JSDoc comment text with displayparts (#43390)
* feat(services): jsdoc use custom name for display parts

* fix(services): jsdoc typo

* feat(services): revert jsDoc changes

* feat(services): jsdoc improve displayparts with more comment kinds

Improve rendering of JSDoc comment text with displayparts for:

- `@typedef`
- `@callback`
- `@param`
- `@property`

* feat(services): jsdoc improve displayparts for template

* test: accept baseline

* test: update jsdoc parameterName

* feat: resolve pr comments

* test: add fourslash tests for jsdoc callback, typedef

* test: accept baselines

* test: revert changes for api baselines

* refactor: naming

* refactor: code quality

* refactor: clean up code as to pr comments
2021-04-09 09:44:44 -07:00

590 lines
16 KiB
Plaintext

[
{
"marker": {
"fileName": "/tests/cases/fourslash/test.js",
"position": 11,
"name": ""
},
"signatureHelp": {
"items": [
{
"isVariadic": false,
"prefixDisplayParts": [
{
"text": "ReadonlyArray",
"kind": "interfaceName"
},
{
"text": ".",
"kind": "punctuation"
},
{
"text": "filter",
"kind": "methodName"
},
{
"text": "<",
"kind": "punctuation"
},
{
"text": "S",
"kind": "typeParameterName"
},
{
"text": " ",
"kind": "space"
},
{
"text": "extends",
"kind": "keyword"
},
{
"text": " ",
"kind": "space"
},
{
"text": "T",
"kind": "typeParameterName"
},
{
"text": ">",
"kind": "punctuation"
},
{
"text": "(",
"kind": "punctuation"
}
],
"suffixDisplayParts": [
{
"text": ")",
"kind": "punctuation"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "S",
"kind": "typeParameterName"
},
{
"text": "[",
"kind": "punctuation"
},
{
"text": "]",
"kind": "punctuation"
}
],
"separatorDisplayParts": [
{
"text": ",",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
}
],
"parameters": [
{
"name": "predicate",
"documentation": [
{
"text": "A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.",
"kind": "text"
}
],
"displayParts": [
{
"text": "predicate",
"kind": "parameterName"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "(",
"kind": "punctuation"
},
{
"text": "value",
"kind": "parameterName"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "T",
"kind": "typeParameterName"
},
{
"text": ",",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "index",
"kind": "parameterName"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "number",
"kind": "keyword"
},
{
"text": ",",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "array",
"kind": "parameterName"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "readonly",
"kind": "keyword"
},
{
"text": " ",
"kind": "space"
},
{
"text": "T",
"kind": "typeParameterName"
},
{
"text": "[",
"kind": "punctuation"
},
{
"text": "]",
"kind": "punctuation"
},
{
"text": ")",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "=>",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "value",
"kind": "text"
},
{
"text": " ",
"kind": "space"
},
{
"text": "is",
"kind": "keyword"
},
{
"text": " ",
"kind": "space"
},
{
"text": "S",
"kind": "typeParameterName"
}
],
"isOptional": false,
"isRest": false
},
{
"name": "thisArg",
"documentation": [
{
"text": "An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.",
"kind": "text"
}
],
"displayParts": [
{
"text": "thisArg",
"kind": "parameterName"
},
{
"text": "?",
"kind": "punctuation"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "any",
"kind": "keyword"
}
],
"isOptional": true,
"isRest": false
}
],
"documentation": [
{
"text": "Returns the elements of an array that meet the condition specified in a callback function.",
"kind": "text"
}
],
"tags": [
{
"name": "param",
"text": [
{
"text": "predicate",
"kind": "parameterName"
},
{
"text": " ",
"kind": "space"
},
{
"text": "A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.",
"kind": "text"
}
]
},
{
"name": "param",
"text": [
{
"text": "thisArg",
"kind": "parameterName"
},
{
"text": " ",
"kind": "space"
},
{
"text": "An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.",
"kind": "text"
}
]
}
]
},
{
"isVariadic": false,
"prefixDisplayParts": [
{
"text": "ReadonlyArray",
"kind": "interfaceName"
},
{
"text": ".",
"kind": "punctuation"
},
{
"text": "filter",
"kind": "methodName"
},
{
"text": "(",
"kind": "punctuation"
}
],
"suffixDisplayParts": [
{
"text": ")",
"kind": "punctuation"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "T",
"kind": "typeParameterName"
},
{
"text": "[",
"kind": "punctuation"
},
{
"text": "]",
"kind": "punctuation"
}
],
"separatorDisplayParts": [
{
"text": ",",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
}
],
"parameters": [
{
"name": "predicate",
"documentation": [
{
"text": "A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.",
"kind": "text"
}
],
"displayParts": [
{
"text": "predicate",
"kind": "parameterName"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "(",
"kind": "punctuation"
},
{
"text": "value",
"kind": "parameterName"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "T",
"kind": "typeParameterName"
},
{
"text": ",",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "index",
"kind": "parameterName"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "number",
"kind": "keyword"
},
{
"text": ",",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "array",
"kind": "parameterName"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "readonly",
"kind": "keyword"
},
{
"text": " ",
"kind": "space"
},
{
"text": "T",
"kind": "typeParameterName"
},
{
"text": "[",
"kind": "punctuation"
},
{
"text": "]",
"kind": "punctuation"
},
{
"text": ")",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "=>",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "unknown",
"kind": "keyword"
}
],
"isOptional": false,
"isRest": false
},
{
"name": "thisArg",
"documentation": [
{
"text": "An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.",
"kind": "text"
}
],
"displayParts": [
{
"text": "thisArg",
"kind": "parameterName"
},
{
"text": "?",
"kind": "punctuation"
},
{
"text": ":",
"kind": "punctuation"
},
{
"text": " ",
"kind": "space"
},
{
"text": "any",
"kind": "keyword"
}
],
"isOptional": true,
"isRest": false
}
],
"documentation": [
{
"text": "Returns the elements of an array that meet the condition specified in a callback function.",
"kind": "text"
}
],
"tags": [
{
"name": "param",
"text": [
{
"text": "predicate",
"kind": "parameterName"
},
{
"text": " ",
"kind": "space"
},
{
"text": "A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.",
"kind": "text"
}
]
},
{
"name": "param",
"text": [
{
"text": "thisArg",
"kind": "parameterName"
},
{
"text": " ",
"kind": "space"
},
{
"text": "An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.",
"kind": "text"
}
]
}
]
}
],
"applicableSpan": {
"start": 11,
"length": 0
},
"selectedItemIndex": 0,
"argumentIndex": 0,
"argumentCount": 0
}
}
]