Uploaded image for project: 'Node.js Driver'
  1. Node.js Driver
  2. NODE-4105

JSDoc comments get compiled into multi-line comments in BSON

XMLWordPrintableJSON

    • Type: Icon: Bug Bug
    • Resolution: Done
    • Priority: Icon: Minor - P4 Minor - P4
    • bson-4.6.3
    • Affects Version/s: None
    • Component/s: None
    • Labels:
    • Not Needed

      What problem are you facing? 

      In the BSON package, some JSDoc comments in certain properties are compiled into the d.ts file as regular JS multi-line comments (starting with /*), which causes things like deprecation notices to not get correctly compiled and thus not show up in a Typescript-powered editor like VS Code.

      What driver and relevant dependency versions are you using?

      MongoDB 4.4.1

      BSON 4.6.1

      Steps to reproduce?

      An example of an incorrectly compiled comment can be found at ObjectId#generationTime, which should be marked as deprecated but it isn't because its JSDoc comment was compiled as a multi-line comment. I'm not sure what could've caused this as the comment is correctly typed in the TS file

            Assignee:
            Unassigned Unassigned
            Reporter:
            rodrigoleitao25@gmail.com Rodrigo Leitão
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved: