Sha256: c00b402135ef36fb09d59519e34d03445fd6541c09e68b189abb64151f211b12

Contents?: true

Size: 742 Bytes

Versions: 61

Compression:

Stored size: 742 Bytes

Contents

import type {DelimiterCase} from './delimiter-case';

/**
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';

// 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> = DelimiterCase<Value, '_'>;

Version data entries

61 entries across 61 versions & 3 rubygems

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