46 lines
1.1 KiB
Plaintext
46 lines
1.1 KiB
Plaintext
import type {DefaultDelimiterCaseOptions, DelimiterCase} from './delimiter-case';
|
|
import type {ApplyDefaultOptions} from './internal';
|
|
import type {WordsOptions} from './words';
|
|
|
|
/**
|
|
Convert a string literal to snake-case.
|
|
|
|
This can be useful when, for example, converting a camel-cased object property to a snake-cased SQL column name.
|
|
|
|
@example
|
|
```
|
|
import type {SnakeCase} from 'type-fest';
|
|
|
|
// Simple
|
|
|
|
const someVariable: SnakeCase<'fooBar'> = 'foo_bar';
|
|
const noSplitOnNumbers: SnakeCase<'p2pNetwork'> = 'p2p_network';
|
|
const splitOnNumbers: SnakeCase<'p2pNetwork', {splitOnNumbers: true}> = 'p_2_p_network';
|
|
|
|
// Advanced
|
|
|
|
type SnakeCasedProperties<T> = {
|
|
[K in keyof T as SnakeCase<K>]: T[K]
|
|
};
|
|
|
|
interface ModelProps {
|
|
isHappy: boolean;
|
|
fullFamilyName: string;
|
|
foo: number;
|
|
}
|
|
|
|
const dbResult: SnakeCasedProperties<ModelProps> = {
|
|
'is_happy': true,
|
|
'full_family_name': 'Carla Smith',
|
|
foo: 123
|
|
};
|
|
```
|
|
|
|
@category Change case
|
|
@category Template literal
|
|
*/
|
|
export type SnakeCase<
|
|
Value,
|
|
Options extends WordsOptions = {},
|
|
> = DelimiterCase<Value, '_', ApplyDefaultOptions<WordsOptions, DefaultDelimiterCaseOptions, Options>>;
|