8ad8b6ba794897222483f99e9f7e21d1d99df7e3ec697e927b188bb211d2df44d1f3d365661b9cee4894cb5807304eb0382a4d49bcb2c27cf94b99da02e13d 672 B

1234567891011121314151617181920212223242526272829303132333435
  1. import {DelimiterCase} from './delimiter-case';
  2. /**
  3. Convert a string literal to snake-case.
  4. This can be useful when, for example, converting a camel-cased object property to a snake-cased SQL column name.
  5. @example
  6. ```
  7. import {SnakeCase} from 'type-fest';
  8. // Simple
  9. const someVariable: SnakeCase<'fooBar'> = 'foo_bar';
  10. // Advanced
  11. type SnakeCasedProps<T> = {
  12. [K in keyof T as SnakeCase<K>]: T[K]
  13. };
  14. interface ModelProps {
  15. isHappy: boolean;
  16. fullFamilyName: string;
  17. foo: number;
  18. }
  19. const dbResult: SnakeCasedProps<ModelProps> = {
  20. 'is_happy': true,
  21. 'full_family_name': 'Carla Smith',
  22. foo: 123
  23. };
  24. ```
  25. */
  26. export type SnakeCase<Value> = DelimiterCase<Value, '_'>;