Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 46 additions & 43 deletions dist/core.d.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
//#region src/core.d.ts
/**
* # 🐪 camelCase
* converts a string to camelCase
Expand All @@ -9,9 +10,9 @@
* @example
* camelCase('$catDog', { keepSpecialCharacters: true }) === '$catDog'
*/
export declare function camelCase(string: string, options?: {
keepSpecialCharacters?: boolean;
keep?: string[];
declare function camelCase(string: string, options?: {
keepSpecialCharacters?: boolean;
keep?: string[];
}): string;
/**
* # 🐫 PascalCase
Expand All @@ -24,9 +25,9 @@ export declare function camelCase(string: string, options?: {
* @example
* pascalCase('$catDog', { keepSpecialCharacters: true }) === '$CatDog'
*/
export declare function pascalCase(string: string, options?: {
keepSpecialCharacters?: boolean;
keep?: string[];
declare function pascalCase(string: string, options?: {
keepSpecialCharacters?: boolean;
keep?: string[];
}): string;
/**
* # 🐫 UpperCamelCase
Expand All @@ -39,7 +40,7 @@ export declare function pascalCase(string: string, options?: {
* @example
* upperCamelCase('$catDog', { keepSpecialCharacters: true }) === '$CatDog'
*/
export declare const upperCamelCase: typeof pascalCase;
declare const upperCamelCase: typeof pascalCase;
/**
* # 🥙 kebab-case
* converts a string to kebab-case
Expand All @@ -51,9 +52,9 @@ export declare const upperCamelCase: typeof pascalCase;
* @example
* kebabCase('$catDog', { keepSpecialCharacters: true }) === '$cat-dog'
*/
export declare function kebabCase(string: string, options?: {
keepSpecialCharacters?: boolean;
keep?: string[];
declare function kebabCase(string: string, options?: {
keepSpecialCharacters?: boolean;
keep?: string[];
}): string;
/**
* # 🐍 snake_case
Expand All @@ -66,9 +67,9 @@ export declare function kebabCase(string: string, options?: {
* @example
* snakeCase('$catDog', { keepSpecialCharacters: true }) === '$cat_dog'
*/
export declare function snakeCase(string: string, options?: {
keepSpecialCharacters?: boolean;
keep?: string[];
declare function snakeCase(string: string, options?: {
keepSpecialCharacters?: boolean;
keep?: string[];
}): string;
/**
* # 📣 CONSTANT_CASE
Expand All @@ -81,9 +82,9 @@ export declare function snakeCase(string: string, options?: {
* @example
* constantCase('$catDog', { keepSpecialCharacters: true }) === '$CAT_DOG'
*/
export declare function constantCase(string: string, options?: {
keepSpecialCharacters?: boolean;
keep?: string[];
declare function constantCase(string: string, options?: {
keepSpecialCharacters?: boolean;
keep?: string[];
}): string;
/**
* # 🚂 Train-Case
Expand All @@ -96,9 +97,9 @@ export declare function constantCase(string: string, options?: {
* @example
* trainCase('$catDog', { keepSpecialCharacters: true }) === '$Cat-Dog'
*/
export declare function trainCase(string: string, options?: {
keepSpecialCharacters?: boolean;
keep?: string[];
declare function trainCase(string: string, options?: {
keepSpecialCharacters?: boolean;
keep?: string[];
}): string;
/**
* # 🕊 Ada_Case
Expand All @@ -111,9 +112,9 @@ export declare function trainCase(string: string, options?: {
* @example
* adaCase('$catDog', { keepSpecialCharacters: true }) === '$Cat_Dog'
*/
export declare function adaCase(string: string, options?: {
keepSpecialCharacters?: boolean;
keep?: string[];
declare function adaCase(string: string, options?: {
keepSpecialCharacters?: boolean;
keep?: string[];
}): string;
/**
* # 👔 COBOL-CASE
Expand All @@ -126,9 +127,9 @@ export declare function adaCase(string: string, options?: {
* @example
* cobolCase('$catDog', { keepSpecialCharacters: true }) === '$CAT-DOG'
*/
export declare function cobolCase(string: string, options?: {
keepSpecialCharacters?: boolean;
keep?: string[];
declare function cobolCase(string: string, options?: {
keepSpecialCharacters?: boolean;
keep?: string[];
}): string;
/**
* # 📍 Dot.notation
Expand All @@ -141,9 +142,9 @@ export declare function cobolCase(string: string, options?: {
* @example
* dotNotation('$catDog', { keepSpecialCharacters: true }) === '$cat.Dog'
*/
export declare function dotNotation(string: string, options?: {
keepSpecialCharacters?: boolean;
keep?: string[];
declare function dotNotation(string: string, options?: {
keepSpecialCharacters?: boolean;
keep?: string[];
}): string;
/**
* # 📂 Path/case
Expand All @@ -156,9 +157,9 @@ export declare function dotNotation(string: string, options?: {
* @example
* pathCase('$catDog', { keepSpecialCharacters: false }) === 'cat/Dog'
*/
export declare function pathCase(string: string, options?: {
keepSpecialCharacters?: boolean;
keep?: string[];
declare function pathCase(string: string, options?: {
keepSpecialCharacters?: boolean;
keep?: string[];
}): string;
/**
* # 🛰 Space case
Expand All @@ -171,9 +172,9 @@ export declare function pathCase(string: string, options?: {
* @example
* spaceCase('$catDog', { keepSpecialCharacters: false }) === 'cat Dog'
*/
export declare function spaceCase(string: string, options?: {
keepSpecialCharacters?: boolean;
keep?: string[];
declare function spaceCase(string: string, options?: {
keepSpecialCharacters?: boolean;
keep?: string[];
}): string;
/**
* # 🏛 Capital Case
Expand All @@ -188,9 +189,9 @@ export declare function spaceCase(string: string, options?: {
*
* ⟪ if you do not want to add spaces, use `pascalCase()` ⟫
*/
export declare function capitalCase(string: string, options?: {
keepSpecialCharacters?: boolean;
keep?: string[];
declare function capitalCase(string: string, options?: {
keepSpecialCharacters?: boolean;
keep?: string[];
}): string;
/**
* # 🔡 lower case
Expand All @@ -205,9 +206,9 @@ export declare function capitalCase(string: string, options?: {
*
* ⟪ if you do not want to add spaces, use the native JS `toLowerCase()` ⟫
*/
export declare function lowerCase(string: string, options?: {
keepSpecialCharacters?: boolean;
keep?: string[];
declare function lowerCase(string: string, options?: {
keepSpecialCharacters?: boolean;
keep?: string[];
}): string;
/**
* # 🔠 UPPER CASE
Expand All @@ -222,7 +223,9 @@ export declare function lowerCase(string: string, options?: {
*
* ⟪ if you do not want to add spaces, use the native JS `toUpperCase()` ⟫
*/
export declare function upperCase(string: string, options?: {
keepSpecialCharacters?: boolean;
keep?: string[];
declare function upperCase(string: string, options?: {
keepSpecialCharacters?: boolean;
keep?: string[];
}): string;
//#endregion
export { adaCase, camelCase, capitalCase, cobolCase, constantCase, dotNotation, kebabCase, lowerCase, pascalCase, pathCase, snakeCase, spaceCase, trainCase, upperCamelCase, upperCase };
Loading