Sha256: 75a7db3b7ddf0ca49651629bb665e0294fda8d19ba04fddc8a14d32bb35eb248

Contents?: true

Size: 921 Bytes

Versions: 61

Compression:

Stored size: 921 Bytes

Contents

/**
Extract all required keys from the given type.

This is useful when you want to create a new type that contains different type values for the required keys only or use the list of keys for validation purposes, etc...

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

declare function createValidation<Entity extends object, Key extends RequiredKeysOf<Entity> = RequiredKeysOf<Entity>>(field: Key, validator: (value: Entity[Key]) => boolean): ValidatorFn;

interface User {
	name: string;
	surname: string;

	luckyNumber?: number;
}

const validator1 = createValidation<User>('name', value => value.length < 25);
const validator2 = createValidation<User>('surname', value => value.length < 25);
```

@category Utilities
*/
export type RequiredKeysOf<BaseType extends object> = Exclude<{
	[Key in keyof BaseType]: BaseType extends Record<Key, BaseType[Key]>
		? Key
		: never
}[keyof BaseType], undefined>;

Version data entries

61 entries across 61 versions & 3 rubygems

Version Path
immosquare-cleaner-0.1.60 node_modules/type-fest/source/required-keys-of.d.ts
immosquare-cleaner-0.1.59 node_modules/type-fest/source/required-keys-of.d.ts
immosquare-cleaner-0.1.58 node_modules/type-fest/source/required-keys-of.d.ts
immosquare-cleaner-0.1.57 node_modules/type-fest/source/required-keys-of.d.ts
immosquare-cleaner-0.1.56 node_modules/type-fest/source/required-keys-of.d.ts
immosquare-cleaner-0.1.55 node_modules/type-fest/source/required-keys-of.d.ts
immosquare-cleaner-0.1.54 node_modules/type-fest/source/required-keys-of.d.ts
immosquare-cleaner-0.1.53 node_modules/type-fest/source/required-keys-of.d.ts
immosquare-cleaner-0.1.52 node_modules/type-fest/source/required-keys-of.d.ts
immosquare-cleaner-0.1.51 node_modules/type-fest/source/required-keys-of.d.ts
clapton-0.0.26 lib/clapton/javascripts/node_modules/type-fest/source/required-keys-of.d.ts
clapton-0.0.25 lib/clapton/javascripts/node_modules/type-fest/source/required-keys-of.d.ts
immosquare-cleaner-0.1.50 node_modules/type-fest/source/required-keys-of.d.ts
clapton-0.0.24 lib/clapton/javascripts/node_modules/type-fest/source/required-keys-of.d.ts
clapton-0.0.23 lib/clapton/javascripts/node_modules/type-fest/source/required-keys-of.d.ts
clapton-0.0.22 lib/clapton/javascripts/node_modules/type-fest/source/required-keys-of.d.ts
clapton-0.0.21 lib/clapton/javascripts/node_modules/type-fest/source/required-keys-of.d.ts
clapton-0.0.20 lib/clapton/javascripts/node_modules/type-fest/source/required-keys-of.d.ts
clapton-0.0.19 lib/clapton/javascripts/node_modules/type-fest/source/required-keys-of.d.ts
clapton-0.0.18 lib/clapton/javascripts/node_modules/type-fest/source/required-keys-of.d.ts