docs: Add release tags and export symbols from entry point #405
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-2837/all-symbol-exports
branch
from
df1faa9 to
156d157
Compare
nbbeeken
commented
Sep 30, 2020
| // the namespace here is used to emulate `export * as EJSON from '...'` | ||
| // which as of now (sept 2020) api-extractor does not support | ||
| // eslint-disable-next-line @typescript-eslint/no-namespace | ||
| export namespace EJSON { |
There was a problem hiding this comment.
As the comment states, the ideal code would be to use export * as ESJON from './...' in bson.ts but unfortunately that syntax is not supported by api-extractor yet, so this is an alternative that could be changed later without breaking changes.
Also unlike our previous solution (a const EJSON = {...} in bson.ts) this will thread the documentation through to the user's import, before it was being lost.
reggi
reviewed
Oct 1, 2020
| @@ -126,10 +128,6 @@ export class ObjectId { | |||
| return this.id.readInt32BE(0); | |||
| } | |||
|
|
|||
| /** | |||
| * Sets the generation time of this ObjectId instance | |||
| * @deprecated Please use createFromTime | |||
There was a problem hiding this comment.
What happened to the dep notice?
There was a problem hiding this comment.
Only the documentation on getters is used, so api-extractor warns to not document setters since it will just be lost, the deprecation on the getter has the createFromTime info.
Also re-enable api-extractor flags to lint our tsdoc blocks. NODE-2837
nbbeeken
force-pushed
the
NODE-2837/all-symbol-exports
branch
from
156d157 to
dcf3219
Compare
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.
Also re-enable api-extractor flags to lint our tsdoc blocks.
NODE-2837