41 lines
1.0 KiB
Plaintext
41 lines
1.0 KiB
Plaintext
import type {DefaultDelimiterCaseOptions} from './delimiter-case';
|
|
import type {DelimiterCasedProperties} from './delimiter-cased-properties';
|
|
import type {ApplyDefaultOptions} from './internal';
|
|
import type {WordsOptions} from './words';
|
|
|
|
/**
|
|
Convert object properties to snake case but not recursively.
|
|
|
|
This can be useful when, for example, converting some API types from a different style.
|
|
|
|
@see SnakeCase
|
|
@see SnakeCasedPropertiesDeep
|
|
|
|
@example
|
|
```
|
|
import type {SnakeCasedProperties} from 'type-fest';
|
|
|
|
interface User {
|
|
userId: number;
|
|
userName: string;
|
|
}
|
|
|
|
const result: SnakeCasedProperties<User> = {
|
|
user_id: 1,
|
|
user_name: 'Tom',
|
|
};
|
|
|
|
const splitOnNumbers: SnakeCasedProperties<{line1: string}, {splitOnNumbers: true}> = {
|
|
'line_1': 'string',
|
|
};
|
|
```
|
|
|
|
@category Change case
|
|
@category Template literal
|
|
@category Object
|
|
*/
|
|
export type SnakeCasedProperties<
|
|
Value,
|
|
Options extends WordsOptions = {},
|
|
> = DelimiterCasedProperties<Value, '_', ApplyDefaultOptions<WordsOptions, DefaultDelimiterCaseOptions, Options>>;
|