Add `PickFromPossiblyUndefined` type #703

Proxxx23 · 2023-10-11T19:34:39Z

I've stumbled upon a problem with Picking from a type that may be undefined. That's why I've decided to make my own type (its name may be changed ofc) and also add it to this fantastic library as a contribution :)

Emiyaaaaa · 2023-10-18T11:51:10Z

Please read the contributing guidelines before submitting contribution.

Proxxx23 · 2023-10-23T20:29:57Z

@Emiyaaaaa you want me to provide real life usage example or what? I've followed guidelines...

Emiyaaaaa · 2023-10-24T04:06:01Z

provide real life usage example

Yes, you need:

Write about some real-world use-cases where it can be useful. (It can be hard sometimes for users to see where they would use something)

source/pick-from-possibly-undefined.d.ts

Emiyaaaaa · 2023-10-24T04:13:00Z

source/pick-from-possibly-undefined.d.ts

+
+type UserWithId = PickFromPossiblyUndefined<User, 'id' | 'name'>;
+
+Results in: UserWithId = { id: number, name: string } | undefined


Result seems { id: number, name: string }, not { id: number, name: string } | undefined.
Did this meet your expectations?

Yes, sorry, you're right. Fixed that one.

Emiyaaaaa · 2023-10-24T04:37:35Z

source/pick-from-possibly-undefined.d.ts

+ **/
+export type PickFromPossiblyUndefined<Type, Props extends keyof NonNullable<Type>> = NonNullable<Type> extends object
+	? Pick<NonNullable<Type>, Props>
+	: NonNullable<Type>;


Why return a nonNullable version of Type? I think this type should have the same behaviour as Pick except not object. or your type more like SafePick ?

It won't work, TS will yell at you if you try to just Pick<Type, Props>. Using NonNullable allows you to pick from possibly undefined, that's the case. Otherwise, you'll see

TS2345: Argument of type unknown is not assignable to parameter of type string

It won't work, TS will yell at you if you try to just Pick. Using NonNullable allows you to pick from possibly undefined, that's the case. Otherwise, you'll see

TS2345: Argument of type unknown is not assignable to parameter of type string

sorry, I mean 'Why return NonNullable<Type> when NonNullable<Type> not extends object?'

Would it be better to return never?

Okay. Let's check now, I've also added some validation so one wouldn't just do:

type UndefinedUserAccount = PickFromPossiblyUndefined<undefined, ''>;

Emiyaaaaa · 2023-10-26T08:26:45Z

need remove .idea folder

Emiyaaaaa · 2023-10-27T04:22:55Z

source/pick-from-possibly-undefined.d.ts

@@ -0,0 +1,23 @@
+/**
+It allows to `Pick` properties from a type that may be undefined
+


need add Use-case

Write about some real-world use-cases where it can be useful. (It can be hard sometimes for users to see where they would use something)
https://github.com/sindresorhus/type-fest/blob/main/.github/contributing.md

Now, better?

readme.md

Emiyaaaaa · 2023-10-27T04:30:32Z

source/pick-from-possibly-undefined.d.ts

+
+@category Object
+ **/
+export type PickFromPossiblyUndefined<Type, Props extends keyof NonNullable<Type>> = Type extends undefined


What is the different with

type PickFromPossiblyUndefined<Type, Props extends keyof NonNullable<Type>> = Pick<NonNullable<Type>, Props>

it won't work the same (tests would crash).

sindresorhus · 2024-02-22T06:40:33Z

source/pick-from-possibly-undefined.d.ts

+
+@category Object
+ **/
+export type PickFromPossiblyUndefined<Type, Props extends keyof NonNullable<Type>> = Type extends undefined


Why are you using NonNullable? We only want undefined, not undefined and null.

How would you do that?

sindresorhus · 2024-02-22T06:41:35Z

readme.md

@@ -144,6 +144,7 @@ Click the type names for complete docs.
 - [`ConditionalKeys`](source/conditional-keys.d.ts) - Extract keys from a shape where values extend the given `Condition` type.
 - [`ConditionalPick`](source/conditional-pick.d.ts) - Like `Pick` except it selects properties from a shape where the values extend the given `Condition` type.
 - [`ConditionalPickDeep`](source/conditional-pick-deep.d.ts) - Like `ConditionalPick` except that it selects the properties deeply.
+- [`PickFromPossiblyUndefined`](source/pick-from-possibly-undefined.d.ts) - `Pick` properties from type that may be undefined.


Suggested change

- [`PickFromPossiblyUndefined`](source/pick-from-possibly-undefined.d.ts) - `Pick` properties from type that may be undefined.

- [`PickFromPossiblyUndefined`](source/pick-from-possibly-undefined.d.ts) - Like `Pick` except it allows a type that is possibly `undefined`.

sindresorhus · 2024-02-22T06:41:49Z

source/pick-from-possibly-undefined.d.ts

+import { PickFromPossiblyUndefined } from 'type-fest';
+
+type BillingDetails = {
+ taxId: string;


Tab-indentation.

sindresorhus · 2024-02-22T06:41:55Z

source/pick-from-possibly-undefined.d.ts

+
+@example:
+```
+import { PickFromPossiblyUndefined } from 'type-fest';


Suggested change

import { PickFromPossiblyUndefined } from 'type-fest';

import {PickFromPossiblyUndefined} from 'type-fest';

sindresorhus · 2024-02-22T06:42:03Z

source/pick-from-possibly-undefined.d.ts

+```
+
+@category Object
+ **/


Suggested change

**/

**/

sindresorhus · 2024-04-22T08:24:16Z

Bump :)

Proxxx23 · 2024-04-22T08:49:55Z

@sindresorhus I don't have this code locally nor in my forked repo. Can I close this PR and make new one? I'll just move this code to another PR and create PR one more time.

sindresorhus · 2024-04-22T09:04:15Z

No need to open a new pull request. The code is right here: https://github.com/Proxxx23/type-fest/tree/main You can just clone it.

Proxxx23 force-pushed the main branch from 1e635fe to e4041b0 Compare October 11, 2023 19:37

Add PickFromPossiblyUndefined type

ec3fccd

Proxxx23 force-pushed the main branch from e4041b0 to ec3fccd Compare October 11, 2023 19:38

Emiyaaaaa reviewed Oct 24, 2023

View reviewed changes

source/pick-from-possibly-undefined.d.ts Outdated Show resolved Hide resolved

Emiyaaaaa reviewed Oct 24, 2023

View reviewed changes

source/pick-from-possibly-undefined.d.ts Outdated Show resolved Hide resolved

Emiyaaaaa reviewed Oct 24, 2023

View reviewed changes

Emiyaaaaa requested changes Oct 24, 2023

View reviewed changes

Proxxx23 force-pushed the main branch from 94ea5e6 to 56edc70 Compare October 24, 2023 19:08

Fixed example code, added test case, disallowed picking from undefined

1b7e0df

Proxxx23 force-pushed the main branch from 56edc70 to 1b7e0df Compare October 25, 2023 06:29

Proxxx23 requested a review from Emiyaaaaa October 26, 2023 08:06

Remode .idea

35ca93a

Proxxx23 force-pushed the main branch from 06c047a to 35ca93a Compare October 26, 2023 11:32

Emiyaaaaa requested changes Oct 27, 2023

View reviewed changes

Better example

8d70ec1

sindresorhus reviewed Feb 22, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `PickFromPossiblyUndefined` type #703

Add `PickFromPossiblyUndefined` type #703

Proxxx23 commented Oct 11, 2023 •

edited

Emiyaaaaa commented Oct 18, 2023 •

edited

Proxxx23 commented Oct 23, 2023

Emiyaaaaa commented Oct 24, 2023

Emiyaaaaa Oct 24, 2023 •

edited

Proxxx23 Oct 24, 2023 •

edited

Emiyaaaaa Oct 24, 2023

Proxxx23 Oct 24, 2023

Emiyaaaaa Oct 24, 2023

fmlukaszmatusik Oct 24, 2023

Emiyaaaaa commented Oct 26, 2023

Emiyaaaaa Oct 27, 2023

Proxxx23 Nov 2, 2023

Emiyaaaaa Oct 27, 2023

Proxxx23 Nov 2, 2023

sindresorhus Feb 22, 2024

Proxxx23 Apr 22, 2024

sindresorhus Feb 22, 2024

sindresorhus Feb 22, 2024

sindresorhus Feb 22, 2024

sindresorhus Feb 22, 2024

sindresorhus commented Apr 22, 2024

Proxxx23 commented Apr 22, 2024

sindresorhus commented Apr 22, 2024


		type UserWithId = PickFromPossiblyUndefined<User, 'id' \| 'name'>;

		Results in: UserWithId = { id: number, name: string } \| undefined

		@@ -0,0 +1,23 @@
		/**
		It allows to `Pick` properties from a type that may be undefined

	- [`PickFromPossiblyUndefined`](source/pick-from-possibly-undefined.d.ts) - `Pick` properties from type that may be undefined.
	- [`PickFromPossiblyUndefined`](source/pick-from-possibly-undefined.d.ts) - Like `Pick` except it allows a type that is possibly `undefined`.

	import { PickFromPossiblyUndefined } from 'type-fest';
	import {PickFromPossiblyUndefined} from 'type-fest';

Add PickFromPossiblyUndefined type #703

Are you sure you want to change the base?

Add PickFromPossiblyUndefined type #703

Conversation

Proxxx23 commented Oct 11, 2023 • edited

Emiyaaaaa commented Oct 18, 2023 • edited

Proxxx23 commented Oct 23, 2023

Emiyaaaaa commented Oct 24, 2023

Emiyaaaaa Oct 24, 2023 • edited

Choose a reason for hiding this comment

Proxxx23 Oct 24, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Emiyaaaaa commented Oct 26, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sindresorhus commented Apr 22, 2024

Proxxx23 commented Apr 22, 2024

sindresorhus commented Apr 22, 2024

Add `PickFromPossiblyUndefined` type #703

Add `PickFromPossiblyUndefined` type #703

Proxxx23 commented Oct 11, 2023 •

edited

Emiyaaaaa commented Oct 18, 2023 •

edited

Emiyaaaaa Oct 24, 2023 •

edited

Proxxx23 Oct 24, 2023 •

edited