45 lines
1.1 KiB
Plaintext
45 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 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.
|
|
|
|
@example
|
|
```
|
|
import type {KebabCase} from 'type-fest';
|
|
|
|
// Simple
|
|
|
|
const someVariable: KebabCase<'fooBar'> = 'foo-bar';
|
|
const someVariableNoSplitOnNumbers: KebabCase<'p2pNetwork', {splitOnNumbers: false}> = 'p2p-network';
|
|
|
|
// Advanced
|
|
|
|
type KebabCasedProperties<T> = {
|
|
[K in keyof T as KebabCase<K>]: T[K]
|
|
};
|
|
|
|
interface CliOptions {
|
|
dryRun: boolean;
|
|
includeFile: string;
|
|
foo: number;
|
|
}
|
|
|
|
const rawCliOptions: KebabCasedProperties<CliOptions> = {
|
|
'dry-run': true,
|
|
'include-file': 'bar.js',
|
|
foo: 123
|
|
};
|
|
```
|
|
|
|
@category Change case
|
|
@category Template literal
|
|
*/
|
|
export type KebabCase<
|
|
Value,
|
|
Options extends WordsOptions = {},
|
|
> = DelimiterCase<Value, '-', ApplyDefaultOptions<WordsOptions, DefaultDelimiterCaseOptions, Options>>;
|