vtils

Home > types > KebabCase

KebabCase type

Convert a string literal to kebab-case.

This can be useful when, for example, converting a camel-cased object property to a kebab-cased CSS class name or a command-line flag.

Signature:

export declare type KebabCase<Value> = DelimiterCase<Value, '-'>;

References: DelimiterCase

Example

``` import {KebabCase} from ‘type-fest’;

// Simple

const someVariable: KebabCase<‘fooBar’> = ‘foo-bar’;

// Advanced

type KebabCasedProperties = { \[K in keyof T as KebabCase\]: T\[K\] };

interface CliOptions { dryRun: boolean; includeFile: string; foo: number; }

const rawCliOptions: KebabCasedProperties = { 'dry-run': true, 'include-file': 'bar.js', foo: 123 }; \`\`\`

Template Literals

This site is open source. Improve this page.