Add api-extractor to help reviewing API changes #116
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
| /// <reference types="node" /> | ||
|
|
||
| import { AmqpError } from 'rhea'; | ||
| import { Connection as Connection_2 } from 'rhea'; |
There was a problem hiding this comment.
is it possible to avoid these?
There was a problem hiding this comment.
It's a known api-extractor issue when there are types with the same names. I can live with it even it is not great.
|
|
||
| // @public (undocumented) | ||
| export namespace EventContext { | ||
| // Warning: (ae-forgotten-export) The symbol "Link" needs to be exported by the entry point index.d.ts |
There was a problem hiding this comment.
I plan to have a separate PR
| constructor(connection: Connection, session: Session_2); | ||
| // (undocumented) | ||
| begin(): void; | ||
| // Warning: (ae-forgotten-export) The symbol "SessionCloseOptions" needs to be exported by the entry point index.d.ts |
| // | ||
| // @public | ||
| export class Connection extends Entity { | ||
| // Warning: (ae-forgotten-export) The symbol "CreatedRheaConnectionOptions" needs to be exported by the entry point index.d.ts |
There was a problem hiding this comment.
Thanks for this PR. I think not having an api document caused all these missed exports.
HarshaNalluru
approved these changes
Oct 3, 2024
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.
Description
This PR adds
@microsoft/api-extractordev dependency to help review API changes and identify issues of missing exports in public API surface.