docs: document reusing a property's type via leaf types#222
Open
1chooo wants to merge 1 commit into
Open
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
Add a README section showing that a property's type can be extracted from a concrete `...Leaf` interface (e.g. `OrganizationLeaf['image']`), avoiding the `Exclude<Organization, string>[...]` workaround needed when indexing the union alias. Documents the request in google#50. Includes a compile-time test asserting the extracted property types work.
1chooo
force-pushed
the
docs/leaf-property
branch
from
1190948 to
6d373e6
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Indexing a union alias like
Organizationto reuse a single property's typefails, because the alias also includes an id-reference
stringthat has noproperties (the workaround was
Exclude<Organization, string>['image']). Sincev2.0.0,
schema-dtsexports concrete...Leafinterfaces, so you can index themdirectly:
OrganizationLeaf['image']. This documents that.Relates to #50.
Changes
packages/schema-dts/test/leaf_property.tscompile-time test assertingthe extracted property types work.
Test plan
npm run buildtsc -p packages/schema-dts/test/passesI have signed / will sign the Google CLA per CONTRIBUTING.md.
Made with Cursor