22 lines
662 B
TypeScript
22 lines
662 B
TypeScript
import {OptionalKeysOf} from './optional-keys-of';
|
|
|
|
/**
|
|
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;
|