scripts/node_modules/type-fest/source/delimiter-cased-properties.d.ts

38 lines
777 B
TypeScript

import type {DelimiterCase} from './delimiter-case';
/**
Convert object properties to delimiter case but not recursively.
This can be useful when, for example, converting some API types from a different style.
@see DelimiterCase
@see DelimiterCasedPropertiesDeep
@example
```
import type {DelimiterCasedProperties} from 'type-fest';
interface User {
userId: number;
userName: string;
}
const result: DelimiterCasedProperties<User, '-'> = {
'user-id': 1,
'user-name': 'Tom',
};
```
@category Change case
@category Template literal
@category Object
*/
export type DelimiterCasedProperties<
Value,
Delimiter extends string,
> = Value extends Function
? Value
: Value extends Array<infer U>
? Value
: {[K in keyof Value as DelimiterCase<K, Delimiter>]: Value[K]};