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

Update tsdoc to inherit from api-extractor settings

XMLWordPrintableJSON

    • Type: Icon: Improvement Improvement
    • Resolution: Unresolved
    • Priority: Icon: Minor - P4 Minor - P4
    • None
    • Affects Version/s: None
    • Component/s: Tooling
    • Labels:
    • Not Needed

      Description

      Adding the extends field to our tsdoc.json settings file can make sure we're using the tags that api-extractor supports for the rollup of documentation & type defintions

      See documentation: https://api-extractor.com/pages/configs/tsdoc_json/

      AC

      • Add the following to tsdoc.json: 
        {
    "extends": [
        "@microsoft/api-extractor/extends/tsdoc-base.json"
    ],
   // ...
    "supportForTags": {
        "@event": true,
        "@since": true,
        "@sinceServerVersion": true,
        "@category": true
    }
}

            Assignee:
            Unassigned Unassigned
            Reporter:
            neal.beeken@mongodb.com Neal Beeken
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated: