mirror of
https://github.com/sindresorhus/type-fest.git
synced 2025-12-08 19:25:05 +00:00
24 lines
686 B
TypeScript
24 lines
686 B
TypeScript
import type {OptionalKeysOf} from './optional-keys-of.d.ts';
|
|
|
|
/**
|
|
Creates a type that represents `true` or `false` depending on whether the given type has any optional fields.
|
|
|
|
This is useful when you want to create an API whose behavior depends on the presence or absence of optional fields.
|
|
|
|
@example
|
|
```
|
|
import type {HasOptionalKeys, OptionalKeysOf} from 'type-fest';
|
|
|
|
type UpdateService<Entity extends object> = {
|
|
removeField: HasOptionalKeys<Entity> extends true
|
|
? (field: OptionalKeysOf<Entity>) => Promise<void>
|
|
: never;
|
|
};
|
|
```
|
|
|
|
@category Utilities
|
|
*/
|
|
export type HasOptionalKeys<BaseType extends object> = OptionalKeysOf<BaseType> extends never ? false : true;
|
|
|
|
export {};
|