Sha256: 3f4d43bb3f61d173a4646c19557e090a06e9a2ec9415313a6d84af388df64923

Contents?: true

Size: 993 Bytes

Versions: 33

Compression:

Stored size: 993 Bytes

Contents

import type {Except} from './except';
import type {Simplify} from './simplify';

/**
Create a type that makes the given keys non-nullable. The remaining keys are kept as is.

Use-case: You want to define a single model where the only thing that changes is whether or not some of the keys are non-nullable.

@example
```
import type {SetNonNullable} from 'type-fest';

type Foo = {
	a: number;
	b: string | undefined;
	c?: boolean | null;
}

type SomeNonNullable = SetNonNullable<Foo, 'b' | 'c'>;
// type SomeNonNullable = {
// 	a: number;
// 	b: string; // Can no longer be undefined.
// 	c?: boolean; // Can no longer be null, but is still optional.
// }
```

@category Object
*/
export type SetNonNullable<BaseType, Keys extends keyof BaseType> =
	Simplify<
		// Pick just the keys that are readonly from the base type.
		Except<BaseType, Keys> &
		// Pick the keys that should be non-nullable from the base type and make them non-nullable.
		{[Key in Keys]: NonNullable<BaseType[Key]>}
	>;

Version data entries

33 entries across 33 versions & 1 rubygems

Version Path
immosquare-cleaner-0.1.60 node_modules/type-fest/source/set-non-nullable.d.ts
immosquare-cleaner-0.1.59 node_modules/type-fest/source/set-non-nullable.d.ts
immosquare-cleaner-0.1.58 node_modules/type-fest/source/set-non-nullable.d.ts
immosquare-cleaner-0.1.57 node_modules/type-fest/source/set-non-nullable.d.ts
immosquare-cleaner-0.1.56 node_modules/type-fest/source/set-non-nullable.d.ts
immosquare-cleaner-0.1.55 node_modules/type-fest/source/set-non-nullable.d.ts
immosquare-cleaner-0.1.54 node_modules/type-fest/source/set-non-nullable.d.ts
immosquare-cleaner-0.1.53 node_modules/type-fest/source/set-non-nullable.d.ts
immosquare-cleaner-0.1.52 node_modules/type-fest/source/set-non-nullable.d.ts
immosquare-cleaner-0.1.51 node_modules/type-fest/source/set-non-nullable.d.ts
immosquare-cleaner-0.1.50 node_modules/type-fest/source/set-non-nullable.d.ts
immosquare-cleaner-0.1.49 node_modules/type-fest/source/set-non-nullable.d.ts
immosquare-cleaner-0.1.48 node_modules/type-fest/source/set-non-nullable.d.ts
immosquare-cleaner-0.1.47 node_modules/type-fest/source/set-non-nullable.d.ts
immosquare-cleaner-0.1.46 node_modules/type-fest/source/set-non-nullable.d.ts
immosquare-cleaner-0.1.45 node_modules/type-fest/source/set-non-nullable.d.ts
immosquare-cleaner-0.1.44 node_modules/type-fest/source/set-non-nullable.d.ts
immosquare-cleaner-0.1.43 node_modules/type-fest/source/set-non-nullable.d.ts
immosquare-cleaner-0.1.42 node_modules/type-fest/source/set-non-nullable.d.ts
immosquare-cleaner-0.1.41 node_modules/type-fest/source/set-non-nullable.d.ts