Skip to content

feat: Adding RequireProp type helper #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: Adding RequireProp type helper #73

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions packages/js-lib/src/typeFest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,21 @@ export type ConditionalExcept<Base, Condition> = Except<Base, ConditionalKeys<Ba
*/
export type ConditionalPick<Base, Condition> = Pick<Base, ConditionalKeys<Base, Condition>>

/**
Makes one property of T required instead of optional.
@example
```
import {RequireProp} from 'type-fest';
interface Example {
a?: string
b?: string
};
type ExampleA = RequireProp<Example, 'a'>;
//=> {a: string; b?: string};
```
*/
export type RequireProp<T, K extends keyof T> = Required<Pick<T, K>> & T

/**
Matches any [typed array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray), like `Uint8Array` or `Float64Array`.
*/
Expand Down