Sha256: c0fe2b1135ca803efa203408c953e1e12645b8065e1a4c1336ad8bb11ea1101b

Contents?: true

Size: 864 Bytes

Versions: 61

Compression:

Stored size: 864 Bytes

Contents

import type {DelimiterCasedPropertiesDeep} from './delimiter-cased-properties-deep';

/**
Convert object properties to snake case recursively.

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

@see SnakeCase
@see SnakeCasedProperties

@example
```
import type {SnakeCasedPropertiesDeep} from 'type-fest';

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

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

const result: SnakeCasedPropertiesDeep<UserWithFriends> = {
	user_info: {
		user_id: 1,
		user_name: 'Tom',
	},
	user_friends: [
		{
			user_id: 2,
			user_name: 'Jerry',
		},
		{
			user_id: 3,
			user_name: 'Spike',
		},
	],
};
```

@category Change case
@category Template literal
@category Object
*/
export type SnakeCasedPropertiesDeep<Value> = DelimiterCasedPropertiesDeep<Value, '_'>;

Version data entries

61 entries across 61 versions & 3 rubygems

Version Path
immosquare-cleaner-0.1.60 node_modules/type-fest/source/snake-cased-properties-deep.d.ts
immosquare-cleaner-0.1.59 node_modules/type-fest/source/snake-cased-properties-deep.d.ts
immosquare-cleaner-0.1.58 node_modules/type-fest/source/snake-cased-properties-deep.d.ts
immosquare-cleaner-0.1.57 node_modules/type-fest/source/snake-cased-properties-deep.d.ts
immosquare-cleaner-0.1.56 node_modules/type-fest/source/snake-cased-properties-deep.d.ts
immosquare-cleaner-0.1.55 node_modules/type-fest/source/snake-cased-properties-deep.d.ts
immosquare-cleaner-0.1.54 node_modules/type-fest/source/snake-cased-properties-deep.d.ts
immosquare-cleaner-0.1.53 node_modules/type-fest/source/snake-cased-properties-deep.d.ts
immosquare-cleaner-0.1.52 node_modules/type-fest/source/snake-cased-properties-deep.d.ts
immosquare-cleaner-0.1.51 node_modules/type-fest/source/snake-cased-properties-deep.d.ts
clapton-0.0.26 lib/clapton/javascripts/node_modules/type-fest/source/snake-cased-properties-deep.d.ts
clapton-0.0.25 lib/clapton/javascripts/node_modules/type-fest/source/snake-cased-properties-deep.d.ts
immosquare-cleaner-0.1.50 node_modules/type-fest/source/snake-cased-properties-deep.d.ts
clapton-0.0.24 lib/clapton/javascripts/node_modules/type-fest/source/snake-cased-properties-deep.d.ts
clapton-0.0.23 lib/clapton/javascripts/node_modules/type-fest/source/snake-cased-properties-deep.d.ts
clapton-0.0.22 lib/clapton/javascripts/node_modules/type-fest/source/snake-cased-properties-deep.d.ts
clapton-0.0.21 lib/clapton/javascripts/node_modules/type-fest/source/snake-cased-properties-deep.d.ts
clapton-0.0.20 lib/clapton/javascripts/node_modules/type-fest/source/snake-cased-properties-deep.d.ts
clapton-0.0.19 lib/clapton/javascripts/node_modules/type-fest/source/snake-cased-properties-deep.d.ts
clapton-0.0.18 lib/clapton/javascripts/node_modules/type-fest/source/snake-cased-properties-deep.d.ts