@lou.codes/types/dist/Replace.d.ts

🏷️ Lou's Code shared types

/**
 * Intersection that replaces the type of some keys in given object type.
 *
 * @category Common
 * @remarks
 * Intersection type to replace all the given keys of an object type with a new
 * type.
 * @example
 * ```typescript
 * type User = { name: string; age: number };
 * type ReallyOldUser = Replace<User, "age", bigint>;
 * ```
 *
 * @template Type Type to replace the type of some keys in.
 * @template Keys Keys to replace the type of.
 * @template NewType New type to replace the old type with.
 */
export type Replace<
	Type extends object,
	Keys extends keyof Type,
	NewType,
> = Omit<Type, Keys> & {
	readonly [Property in Keys]: NewType;
};