36 lines
943 B
Plaintext
36 lines
943 B
Plaintext
import type {HasRequiredKeys} from './has-required-keys';
|
|
import type {RequireAtLeastOne} from './require-at-least-one';
|
|
|
|
/**
|
|
Represents an object with at least 1 non-optional key.
|
|
|
|
This is useful when you need an object where all keys are optional, but there must be at least 1 key.
|
|
|
|
@example
|
|
```
|
|
import type {NonEmptyObject} from 'type-fest';
|
|
|
|
type User = {
|
|
name: string;
|
|
surname: string;
|
|
id: number;
|
|
};
|
|
|
|
type UpdateRequest<Entity extends object> = NonEmptyObject<Partial<Entity>>;
|
|
|
|
const update1: UpdateRequest<User> = {
|
|
name: 'Alice',
|
|
surname: 'Acme',
|
|
};
|
|
|
|
// At least 1 key is required, therefore this will report a 2322 error:
|
|
// Type '{}' is not assignable to type 'UpdateRequest<User>'
|
|
const update2: UpdateRequest<User> = {};
|
|
```
|
|
|
|
@see Use `IsEmptyObject` to check whether an object is empty.
|
|
|
|
@category Object
|
|
*/
|
|
export type NonEmptyObject<T extends object> = HasRequiredKeys<T> extends true ? T : RequireAtLeastOne<T, keyof T>;
|