type-fest/source/delimiter-cased-properties.d.ts
2025-11-30 04:44:57 +07:00

49 lines
1.2 KiB
TypeScript

import type {_DefaultDelimiterCaseOptions, DelimiterCase} from './delimiter-case.d.ts';
import type {ApplyDefaultOptions} from './internal/index.d.ts';
import type {WordsOptions} from './words.d.ts';
/**
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 {@link DelimiterCase}
@see {@link DelimiterCasedPropertiesDeep}
@example
```
import type {DelimiterCasedProperties} from 'type-fest';
type User = {
userId: number;
userName: string;
};
const result: DelimiterCasedProperties<User, '-'> = {
'user-id': 1,
'user-name': 'Tom',
};
const splitOnNumbers: DelimiterCasedProperties<{line1: string}, '-', {splitOnNumbers: true}> = {
'line-1': 'string',
};
```
@category Change case
@category Template literal
@category Object
*/
export type DelimiterCasedProperties<
Value,
Delimiter extends string,
Options extends WordsOptions = {},
> = Value extends Function
? Value
: Value extends Array<infer U>
? Value
: {[K in keyof Value as
DelimiterCase<K, Delimiter, ApplyDefaultOptions<WordsOptions, _DefaultDelimiterCaseOptions, Options>>
]: Value[K]};
export {};