Type Alias ScreamingSnakeCase<Value, Options>

ScreamingSnakeCase: Value extends string
? Uppercase<SnakeCase<Value, Options>>
: Value

Convert a string literal to screaming-snake-case.

This can be useful when, for example, converting a camel-cased object property to a screaming-snake-cased SQL column name.

Type Parameters

Value
Options extends WordsOptions = { splitOnNumbers: false }

Example

import type {ScreamingSnakeCase} from 'type-fest';

const someVariable: ScreamingSnakeCase<'fooBar'> = 'FOO_BAR';
const someVariableNoSplitOnNumbers: ScreamingSnakeCase<'p2pNetwork', {splitOnNumbers: false}> = 'P2P_NETWORK';