fix: add all accessor tags to exported symbols #2649
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nbbeeken
force-pushed
the
NODE-2783/access-symbols
branch
from
ffe74e7
to
9d67c5d
Compare
mbroadst
approved these changes
Dec 2, 2020
emadum
suggested changes
Dec 2, 2020
There was a problem hiding this comment.
There were a lot of changes from internal => public or from public => internal in this PR that I don't fully understand. For example, AbstractCursor became public but ChangeStreamCursorOptions became internal.
Could you update the description to explain the general reasoning behind why these had to change?
nbbeeken
force-pushed
the
NODE-2783/access-symbols
branch
from
9d67c5d
to
d93e6df
Compare
nbbeeken
commented
Dec 2, 2020
Comment on lines
-94
to
+99
| "build:dts": "npm run build:ts && api-extractor run --typescript-compiler-folder node_modules/typescript --local && rimraf 'lib/**/*.d.ts*'", | ||
| "build:dts": "npm run build:ts && api-extractor run && rimraf 'lib/**/*.d.ts*'", | ||
| "build:docs": "npm run build:dts && typedoc", | ||
| "check:bench": "node test/benchmarks/driverBench", | ||
| "check:coverage": "nyc npm run check:test", | ||
| "check:lint": "npm run check:ts && eslint -v && eslint --max-warnings=0 --ext '.js,.ts' src test", | ||
| "check:lint": "npm run build:dts && npm run check:eslint", | ||
| "check:eslint": "eslint -v && eslint --max-warnings=0 --ext '.js,.ts' src test", |
The mongodb.d.ts now only includes the public API. NODE-2783
nbbeeken
force-pushed
the
NODE-2783/access-symbols
branch
from
d93e6df
to
32c37f7
Compare
emadum
approved these changes
Dec 3, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The mongodb.d.ts now only includes the public API.
NODE-2783
API-extractor enforces that things that are public can only depend upon types and symbols that are also public unless stated otherwise. So for example our ChangeStreams API hides the underlying cursor it uses from the public API so we can make both the ChangeStreamsCursor and its Options type internal which deletes them from the final type definition, implicitly (but not literally) making them inaccessible to type checking users.
Some symbols needed to be made public since they are exposed to users. For example
BulkWriteResulthas a result property that had an internalBulkResulttype but since the public definitions file would have that removed you would get a compilation error when it tries to type the publicresultproperty as the deletedBulkResulttype.