Repository navigation
Provide easier access to object in JavaScript JSDoc #34980
Description
Search Terms
Suggestion
There should be a compiler option like strictJSDocTypes or something to disable the object to any conversion present in TypeScript’s JSDoc parser.
Use Cases
I’m currently forced to use:
/** @typedef {NonNullable<Parameters<typeof Object.create>[0]>} obj */to get a reference to TypeScript’s object type.
Examples
Any code where I use the above.
The following code creates an object with writable, configurable and non‑enumerable properties:
var ES = require("es-abstract");
var define = require("define-properties");
var $ObjectCreate = GetIntrinsic("%Object.create%", true);
/**
* @template {object} M
* @param {object | null} proto
* @param {M & ThisType<any>} [props]
* @return {object}
*/
function createObj(proto, props) {
var result = ES.ObjectCreate(proto);
if (arguments.length > 1) {
define(result, props);
}
return result;
}All instances of object in the above code currently have to be replaced with the obj type alias.
Checklist
My suggestion meets these guidelines:
- This wouldn't be a breaking change in existing TypeScript/JavaScript code
- This wouldn't change the runtime behavior of existing JavaScript code
- This could be implemented without emitting different JS based on the types of the expressions
- This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
- This feature would agree with the rest of TypeScript's Design Goals.
Activity
andrewbranch commentedon Dec 6, 2019
Nathan Shively-Sanders (@sandersn) my understanding from microsoft/TypeScript-New-Handbook#36 was that
objectwas no longer rewritten toanyas of 3.7, but it doesn’t seem like that’s the case?sandersn commentedon Dec 11, 2019
derp! yes, I misread the code when writing that new text.
getIntendedTypeFromJSDocTypeReferencedoesn't handleobject, so I assumed that a discussion I had earlier about turning offobject -> anyhad resulted in the change. But actually it only operates on type references, not keywords.objectis a keyword, so it's handled ingetTypeFromTypeNode.I need to track down that discussion, because I think it had some analysis of actual usage.
sandersn commentedon Dec 11, 2019
But in summary:
objectto meananythe way we've observedObjectbeing used.