JSDoc: Support @readonly tag #17233

Activity

1. ghost added

   Salsa

   on Jul 16, 2017
2. Mohamed Hegazy (mhegazy)

   added

   Domain: JSDocRelates to JSDoc parsing and type generationRelates to JSDoc parsing and type generation

   SuggestionAn idea for TypeScriptAn idea for TypeScript

   on Aug 31, 2017
3. niedzielski commented on Oct 14, 2018

   

   stephen (niedzielski)

   on Oct 14, 2018

   More actions

   This would be awesome! There's already support for Readonly and readonly in JSDoc closure syntax. E.g.:

   /** 
    * @typedef {Readonly<{
    *   foo: ReadonlyArray<Foo>
    *   bar: number
    * }>} Baz
    */

   /**
    * @typedef {{
    *   readonly foo: ReadonlyArray<Foo>
    *   readonly bar: number
    * }} Baz
    */

   Both of the above examples work as expected. However, resolving this ticket would enable readonly support for member properties too:

   /**
    * @typedef {Object} Baz
    * @prop {ReadonlyArray<Foo>} foo This syntax supports comments.
    * @prop {number} bar But there's no support for marking properties as @readonly.
    */
4. Wesley Wigham (weswigham)

   added

   In DiscussionNot yet reached consensusNot yet reached consensus

   on Nov 6, 2018
5. Wesley Wigham (weswigham)

   added

   Domain: JavaScriptThe issue relates to JavaScript specificallyThe issue relates to JavaScript specifically

   and removed

   Salsa

   on Nov 29, 2018
6. Nathan Shively-Sanders (sandersn)

   closed this as completedin #35790on Dec 20, 2019