Types incorrectly marked as @internal #352
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
Types only need to be marked as `@internal` if they would be exported
from the top level `index.ts` file, but you don't want them to. Marking
something as `@internal` means they are stripped from the compiled type
files and this causes type errors because some files will try to
reference types that do not exist anymore.
Example error when running `tsc` in a project where `@pulumi/cdk` is
installed.
```
node_modules/@pulumi/cdk/lib/converters/app-converter.d.ts:6:10 - error TS2305: Module '"../interop"' has no exported member 'CdkConstruct'.
6 import { CdkConstruct } from '../interop';
~~~~~~~~~~~~
```
I've unmarked things as `@internal` that are not exported and moved some
things to a new `interna/interop.ts` file that were in an exported file.
Now that they are not in an exported file we don't have to mark them as
`@internal`
|
Sounds like we misunderstood @internal due to our TypeScript skill issues, thanks! |
t0yv0
approved these changes
Feb 20, 2025
|
This PR has been shipped in release v1.8.0. |
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.
Types only need to be marked as
@internalif they would be exportedfrom the top level
index.tsfile, but you don't want them to. Markingsomething as
@internalmeans they are stripped from the compiled typefiles and this causes type errors because some files will try to
reference types that do not exist anymore.
Example error when running
tscin a project where@pulumi/cdkisinstalled.
I've unmarked things as
@internalthat are not exported and moved somethings to a new
interna/interop.tsfile that were in an exported file.Now that they are not in an exported file we don't have to mark them as
@internal