Type Alias DelimiterCasedPropertiesDeep<Value, Delimiter>

DelimiterCasedPropertiesDeep: Value extends Function
| Date
| RegExp
    ? Value
    : Value extends (infer U)[]
        ? DelimiterCasedPropertiesDeep<U, Delimiter>[]
        : Value extends Set<infer U>
            ? Set<DelimiterCasedPropertiesDeep<U, Delimiter>>
            : {
                [K in keyof Value as DelimiterCase<K, Delimiter>]: DelimiterCasedPropertiesDeep<
                    Value[K],
                    Delimiter,
                >
            }

Convert object properties to delimiter case recursively.

This can be useful when, for example, converting some API types from a different style.

Type Parameters

  • Value
  • Delimiter extends string

See

  • DelimiterCase
  • DelimiterCasedProperties

Example

import type {DelimiterCasedPropertiesDeep} from 'type-fest';

interface User {
	userId: number;
	userName: string;
}

interface UserWithFriends {
	userInfo: User;
	userFriends: User[];
}

const result: DelimiterCasedPropertiesDeep<UserWithFriends, '-'> = {
	'user-info': {
	'user-id': 1,
		'user-name': 'Tom',
	},
	'user-friends': [
		{
			'user-id': 2,
			'user-name': 'Jerry',
		},
		{
			'user-id': 3,
			'user-name': 'Spike',
		},
	],
};

Settings

Member Visibility