Skip to content

Commit ba9ddf6

Browse files
committed
refactor: function name and docs
1 parent 5bc8d1e commit ba9ddf6

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

src/rules/checkTypes.js

+6-3
Original file line numberDiff line numberDiff line change
@@ -167,13 +167,16 @@ export default iterateJsdoc(({
167167
};
168168

169169
/**
170+
* Iterates strict types to see if any should be added to `invalidTypes` (and
171+
* the the relevant strict type returned as the new preferred type).
172+
*
170173
* @param {string} typeNodeName
171174
* @param {string} preferred
172175
* @param {import('jsdoc-type-pratt-parser/dist/src/index.d.ts').NonTerminalResult} parentNode
173176
* @param {string[]} invalidTypes
174-
* @returns {string} The `preferred` string, optionally changed
177+
* @returns {string} The `preferred` type string, optionally changed
175178
*/
176-
const check = (typeNodeName, preferred, parentNode, invalidTypes) => {
179+
const checkNativeTypes = (typeNodeName, preferred, parentNode, invalidTypes) => {
177180
let changedPreferred = preferred;
178181
for (const strictNativeType of strictNativeTypes) {
179182
if (
@@ -279,7 +282,7 @@ export default iterateJsdoc(({
279282
typeNodeName, types,
280283
]);
281284
} else if (!noDefaults && type === 'JsdocTypeName') {
282-
preferred = check(typeNodeName, preferred, parentNode, invalidTypes);
285+
preferred = checkNativeTypes(typeNodeName, preferred, parentNode, invalidTypes);
283286
}
284287

285288
// For fixer

0 commit comments

Comments
 (0)