UNPKG

type-fest

Version:

A collection of essential TypeScript types

48 lines (37 loc) • 1.28 kB
import type {CamelCaseOptions} from './camel-case.d.ts'; import type {PascalCase} from './pascal-case.d.ts'; import type {PascalCasedPropertiesDeep} from './pascal-cased-properties-deep.d.ts'; // For `@link` /** Convert top-level object properties to pascal case. This can be useful when, for example, converting some API types from a different style. @see {@link PascalCase} @see {@link PascalCasedPropertiesDeep} @example ``` import type {PascalCasedProperties} from 'type-fest'; type User = { userId: number; userName: string; }; const result: PascalCasedProperties<User> = { UserId: 1, UserName: 'Tom', }; const preserveConsecutiveUppercase: PascalCasedProperties<{fooBAR: string}, {preserveConsecutiveUppercase: true}> = { FooBAR: 'string', }; const noSplitOnPunctuation: PascalCasedProperties<{'foo::bar': string}, {splitOnPunctuation: false}> = { 'Foo::bar': 'string', }; ``` @category Change case @category Template literal @category Object */ export type PascalCasedProperties<Value, Options extends CamelCaseOptions = {}> = Value extends Function ? Value : Value extends readonly unknown[] // Arrays pass through unchanged, since they have no properties to re-case. ? Value : {[K in keyof Value as PascalCase<K, Options>]: Value[K]}; export {};