Support of "nullable types" or optional paramaters ({?number}, {string} [myParam], etc) about tsd-jsdoc HOT 12 CLOSED

sure, I create an issue in dts-dom RyanCavanaugh/dts-dom#27

from tsd-jsdoc.

fixed

from tsd-jsdoc.

@englercj
i think it is a bug of dts-dom.
https://github.com/RyanCavanaugh/dts-dom/blob/master/lib/index.ts#L672-L674

here it doesn't add ? for the method of interface

from tsd-jsdoc.

The jsdoc comment it output verbatim from what jsdoc gives us (we indent it, but that's it). If the comment is wrong in the output, then jsdoc isn't parsing it the way you think it is. I'm pretty sure that is CC syntax not JSDoc (strictly speaking), maybe that is the issue?

That being said, there isn't really a "nullable" concept in Typescript so I'm not sure how I would express that concept anyway (outside the comment).

from tsd-jsdoc.

Hi @englercj

Thanks for your quick answer.
You're right about nullable parameter for Typescript.

The syntax comes from usejsdoc.org:

Nullable type | A number or null.
{?number}
This indicates that the type is either the specified type, or null.

But you're right, what I'd rather use is optional parameters, which look like:

/**
 * @param {number} [eventValue] (optional) Value attached to the target event.
 */

Optional parameter | An optional parameter named foo.
@param {number} [foo]
Indicates that the parameter is optional. When using JSDoc's syntax for optional parameters, you can also indicate the value that will be used if a parameter is omitted.

Which should be, in typescript:

function logEvent(eventValue?: number) { }

According to the TS doc @ "Optional and Default Parameters"

from tsd-jsdoc.

Optional parameters (and interface members) should already work correctly now, is that working for you?

As for nullable, not sure why your comment is rewritten but also pretty sure it isn't a bug in this repo.

from tsd-jsdoc.

Hi @englercj, thanks for your great tools.

but, it's still not working for me (2.0.0-beta.3)

JavaScript

/**
 * @interface i
 */
var i = {}
/**
 * @method i.f
 * @param {number} [optional] - optional pararms
 */
i.f = function (optional) { }

.d.ts

/**
 * @interface i
 */
declare interface i {
    /**
     * @method i.f
     * @param {number} [optional] - optional pararms
     */
    f(optional: number): void; // should be f(optional?: number)
}

When commentting i as class, it will parse correctly.
is there any bug?

from tsd-jsdoc.

@englercj Sorry for the delay - The "optional parameter" syntax is not working.
Just like @NewFuture , I am using @interface (appropriate).

from tsd-jsdoc.

Hmm, I'll have to look into that. If it is working in class, but not interface then it is likely a bug. Strangely though this lib doesn't treat functions in interfaces and classes differently. It is possible jsdoc has another parsing issue.

from tsd-jsdoc.

I built the js file to html by the JSDOC,.
in the result, the optional will be marked as opt correctly.

Maybe jsdoc has different behaviors for the methods of class and inteface.

from tsd-jsdoc.

Ah, great catch! That certainly seems like the issue. Thanks for tracking this down.

from tsd-jsdoc.

(previous comment removed)

Thanks for handling this with us @NewFuture ! Thanks again for your work @englercj

from tsd-jsdoc.