type-fest/source/writable-keys-of.d.ts

34 lines
868 B
TypeScript

import type {IsEqual} from './is-equal.d.ts';
/**
Extract all writable keys from the given type.
This is useful when you want to create a new type that contains writable keys only.
@example
```
import type {WritableKeysOf} from 'type-fest';
interface User {
name: string;
surname: string;
readonly id: number;
}
type UpdateRequest<Entity extends object> = Pick<Entity, WritableKeysOf<Entity>>;
const update1: UpdateRequest<User> = {
name: 'Alice',
surname: 'Acme',
};
```
@category Utilities
*/
export type WritableKeysOf<T extends object> =
T extends unknown // For distributing `T`
? (keyof {
[P in keyof T as IsEqual<{[Q in P]: T[P]}, {readonly [Q in P]: T[P]}> extends false ? P : never]: never
}) & keyof T // Intersect with `keyof T` to ensure result of `WritableKeysOf<T>` is always assignable to `keyof T`
: never; // Should never happen