Optional properties

[ikokostya]

documentation skips optional properties in typedef declaration:

/**
 * @typedef {Object} Foo
 * @property {Number} a
 * @property {Number} [b]
 */

$ documentation build test.js -f json
[
  {
    "description": "",
    "tags": [
      {
        "title": "typedef",
        "description": null,
        "lineNumber": 1,
        "type": {
          "type": "NameExpression",
          "name": "Object"
        },
        "name": "Foo"
      },
      {
        "title": "property",
        "description": null,
        "lineNumber": 2,
        "type": {
          "type": "NameExpression",
          "name": "Number"
        },
        "name": "a"
      }
    ],
    "loc": {
      "start": {
        "line": 1,
        "column": 0
      },
      "end": {
        "line": 5,
        "column": 3
      }
    },
    "context": {
      "loc": {
        "start": {
          "line": 1,
          "column": 0
        },
        "end": {
          "line": 6,
          "column": 0
        }
      },
      "file": "/home/kostya/proj/typedef-test/test.js"
    },
    "typedef": {
      "name": "Foo",
      "type": {
        "type": "NameExpression",
        "name": "Object"
      }
    },
    "properties": [
      {
        "title": "property",
        "description": null,
        "lineNumber": 2,
        "type": {
          "type": "NameExpression",
          "name": "Number"
        },
        "name": "a"
      }
    ],
    "name": "Foo",
    "kind": "typedef",
    "members": {
      "instance": [],
      "static": []
    },
    "path": [
      "Foo"
    ]
  }
]

How I can define optional properties?

[tmcw]

Optional properties cannot be specified at this point; JSDoc doesn't support optional properties and as a result doctrine (the parser documentation.js uses) doesn't either. If you're interested in rallying support for this idea, the first place to start would be to get it into the doctrine parser.

[ikokostya]

Optional properties cannot be specified at this point; JSDoc doesn't support optional properties

jsdoc3 marks property b from my example as optional

[ikokostya]

doctrine supports optional properties since 1.4.0 version. I think this issue can be closed.

[arv]

We need to infer it too:

type T = {
  opt?: number,
  req: string,
};

(I looked at this a few days ago and I didn't see any support in Doctrine?)

[ikokostya]

(I looked at this a few days ago and I didn't see any support in Doctrine?)

This feature was implemented yesterday.

This is output for property b with latest doctrine (don't forget reinstall node_modules):

{
  "name": "b",
  "lineNumber": 3,
  "type": {
    "type": "OptionalType",
    "expression": {
      "type": "NameExpression",
      "name": "Number"
    }
  }
}

[arv]

I see. The type is optional, not the field. I guess we could work with that.

On Wed, Sep 14, 2016, 06:09 ikokostya [email protected] wrote:

(I looked at this a few days ago and I didn't see any support in Doctrine?)

This feature was implemented yesterday.

This is output for property b with latest doctrine (don't forget
reinstall node_modules):

{
"name": "b",
"lineNumber": 3,
"type": {
"type": "OptionalType",
"expression": {
"type": "NameExpression",
"name": "Number"
}
}
}

—
You are receiving this because you modified the open/close state.

Reply to this email directly, view it on GitHub
#347 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/AACzFYCcKLEhzyI5LQyeP1ERVuAdySYUks5qp_IhgaJpZM4HU-79
.

[ikokostya]

The type is optional, not the field.

Hmm. Yes, this is weird, but consistent with optional parameters which have OptionalType too.

[ikokostya]

#547 was merged. @arv Can this issue be closed?