-
Type:
Task
-
Resolution: Fixed
-
Priority:
Major - P3
-
Affects Version/s: None
-
Component/s: 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 , Db, Collection, 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