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

Add access modifiers to all driver symbols

    • Type: Icon: Task Task
    • Resolution: Fixed
    • Priority: Icon: Major - P3 Major - P3
    • 4.0.0
    • Affects Version/s: None
    • Component/s: None
    • None
    • None
    • None
    • None
    • None
    • None

      All of the symbols in the driver need to be correctly marked as public or internal, you can use api extractor to discover a list of symbols that have yet to be annotated. When the symbols have been annotated many may be removed from src/index.ts since they are no longer public.

      a good rule of thumb is that only things exposed from the MongoClient , DbCollection, GridFS and cursor types (including ChangeStream) should be exported, meanwhile SDAM, CMAP, should be  internal, although we do technically expose the TopologyDescription.

      YMMV, You can use the npm run build:docs and open docs/public/index.html to get a good quick glance at the public types 

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

              Created:
              Updated:
              Resolved: