Add DeepFlattenRecord type (and helpers)
#571
Closed
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
Signed-off-by: dwheale-equi <[email protected]>
|
What are all the types that have been added? It would probably help to add them to the PR description. Do all of them need to be exposed, or can some be internal / part of I think the convention is that |
sindresorhus
requested changes
Mar 14, 2023
|
|
||
| type ExampleType = { | ||
| arrayKey: string[]; | ||
| objectKey: { |
| @param {{ cascadeOptionality?: boolean }} Options The options to use when flattening | ||
| @example | ||
| ``` | ||
| import type { DeepFlattenRecord } from 'type-fest'; |
There was a problem hiding this comment.
Suggested change
| import type { DeepFlattenRecord } from 'type-fest'; | |
| import type {DeepFlattenRecord} from 'type-fest'; |
|
|
||
| This is useful when you have a nested object that you want to use as a form or table schema, but you want to flatten it into a single object. | ||
|
|
||
| @param BaseType The type to flatten |
There was a problem hiding this comment.
Suggested change
| @param BaseType The type to flatten | |
| @param BaseType - The type to flatten. |
| /** | ||
| Deeply flattens a Record type recursively. If a key is an object, it will be flattened into the parent object. | ||
| By default, if a key containing an object is optional,the object will be flattened into the parent object and all | ||
| it's keys will be optional. This can be disabled by setting `cascadeOptionality` in `DeepFlattenOptions` to `false`. |
Comment on lines
+12
to
+15
| /** | ||
| Whether to cascade optionality on an object (e.g. if a parent is optional, all children will be as well regardless of their original optionality) | ||
| @default true | ||
| */ |
There was a problem hiding this comment.
Suggested change
| /** | |
| Whether to cascade optionality on an object (e.g. if a parent is optional, all children will be as well regardless of their original optionality) | |
| @default true | |
| */ | |
| /** | |
| Whether to cascade optionality on an object (e.g. if a parent is optional, all children will be as well regardless of their original optionality) | |
| @default true | |
| */ |
|
Bump |
|
Closing for lack of response: #633 |
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.
I know the preference is to submit one type per PR but the other types are required for
DeepFlattenRecordto work. I found that an API I was pulling from provided data in a nested format, which I needed flattened.