Update TS Guides for Native Types #2064
Open
+214
−213
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
✅ Deploy Preview for ember-guides ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
15 tasks
gitKrystan
force-pushed
the
ember-data-types
branch
from
2bd0a11 to
8aea5da
Compare
gitKrystan
force-pushed
the
ember-data-types
branch
from
8aea5da to
8948e56
Compare
gitKrystan
commented
Dec 17, 2024
| </p> | ||
| <p> | ||
| For improved (albeit less stable) types, you can switch to <a href="https://github.com/emberjs/data/blob/main/guides/typescript/index.md">EmberData's alpha native types, documented at this link</a>. Using the EmberData alpha native types will also require <a href="https://blog.emberjs.com/stable-typescript-types-in-ember-5-1/">switching to the Ember native types</a>, which are guaranteed to always be 100% correct and 100% up to date! | ||
| The following content applies to the native EmberData types, which are currently considered "unstable" (though in practice, they've been pretty stable as of late). These guides may change as the EmberData types are finalized. |
There was a problem hiding this comment.
NOTE: I only updated the existing docs to make sure they weren't wrong. I did not add any new docs re: requests, builders, includes, etc. (Will do so in a separate PR.)
gitKrystan
changed the title
|
This looks like a lot of good content, should we mark ready-for-review and try to get this merged? Even if there is further content needed to be "done" documenting native types. |
| }, | ||
| "types": [ | ||
| "ember-source/types", | ||
| "./node_modules/ember-data/unstable-preview-types", |
There was a problem hiding this comment.
Suggested change
| "./node_modules/ember-data/unstable-preview-types", | |
| "ember-data/unstable-preview-types", |
There was a problem hiding this comment.
Did we change this? IIRC the output in my diff is direct copy-pasta from actual --typescript output, but that was also weeks ago when I originally made this PR.
There was a problem hiding this comment.
Yeah, it's recent as of a couple days ago
- [BUGFIX release]: tsconfig.json referenced paths to types instead of imports ember-cli/ember-cli#10612
- Add smoke-tests for types, build, etc emberjs/data#9633
- Add tests for usage in npm and yarn repos emberjs/data#9630
- 6.1, ember-data TS config is broken in monorepo when using npm or yarn@1 ember-cli/ember-cli#10611
| "ember-source/types", | ||
| "./node_modules/ember-data/unstable-preview-types", | ||
| // ...more ember-data types... | ||
| "./node_modules/@warp-drive/core-types/unstable-preview-types" |
There was a problem hiding this comment.
Suggested change
| "./node_modules/@warp-drive/core-types/unstable-preview-types" | |
| "@warp-drive/core-types/unstable-preview-types" |
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.
No description provided.