slug

function transliterate(input: string, options?: TransliterateOptions): string

Transliterate Unicode characters to ASCII Uses a hybrid approach for optimal bundle size: 1. Custom transliteration function (if provided) 2. Custom character replacements 3. Default replacement map (common symbols, Germanic, Nordic, etc.) 4. NFD normalization for diacritics (native, 0 bytes)

function sanitize(input: string, options?: SanitizeOptions): string

Sanitize a string by removing/replacing unwanted characters

function separateWords(input: string, preserve?: string[]): string[]

Separate words from a string Handles multiple patterns: - Existing separators (spaces, hyphens, underscores, slashes, dots) - camelCase → camel Case - PascalCase → Pascal Case - FOOBar → FOO Bar (consecutive caps) - foo2Bar → foo 2 Bar (numbers)

function escapeRegex(str: string): string

Escape special regex characters

Default character replacements for common symbols and special characters Optimized for bundle size while covering most common cases Strategy: - NFD normalization handles accented letters (é→e, ñ→n, ü→u, ö→o, ä→a, etc.) - This map only includes characters that NFD doesn't handle - Matches behavior of

function createSlugger(defaultOptions?: SlugOptions): Slugger

Create a custom slugger with preset options Useful for reusing the same slug configuration multiple times

function uniqueSlug(input: string, checker: ExistenceChecker, options?: SlugOptions): Promise<string>

Generate a unique slug by appending a counter if needed Checks for slug existence and appends a number if the slug already exists

function uniqueSlugSync(input: string, existing: Set<string>, options?: SlugOptions): string

Synchronous version of uniqueSlug for Set-based checkers only

function createSlugger(defaultOptions?: SlugOptions): Slugger

Create a custom slugger with preset options Useful for reusing the same slug configuration multiple times

function uniqueSlug(input: string, checker: ExistenceChecker, options?: SlugOptions): Promise<string>

Generate a unique slug by appending a counter if needed Checks for slug existence and appends a number if the slug already exists

function uniqueSlugSync(input: string, existing: Set<string>, options?: SlugOptions): string

Synchronous version of uniqueSlug for Set-based checkers only

function transliterate(input: string, options?: TransliterateOptions): string

Transliterate Unicode characters to ASCII Uses a hybrid approach for optimal bundle size: 1. Custom transliteration function (if provided) 2. Custom character replacements 3. Default replacement map (common symbols, Germanic, Nordic, etc.) 4. NFD normalization for diacritics (native, 0 bytes)

function sanitize(input: string, options?: SanitizeOptions): string

Sanitize a string by removing/replacing unwanted characters

function separateWords(input: string, preserve?: string[]): string[]

Separate words from a string Handles multiple patterns: - Existing separators (spaces, hyphens, underscores, slashes, dots) - camelCase → camel Case - PascalCase → Pascal Case - FOOBar → FOO Bar (consecutive caps) - foo2Bar → foo 2 Bar (numbers)

function escapeRegex(str: string): string

Escape special regex characters

Default character replacements for common symbols and special characters Optimized for bundle size while covering most common cases Strategy: - NFD normalization handles accented letters (é→e, ñ→n, ü→u, ö→o, ä→a, etc.) - This map only includes characters that NFD doesn't handle - Matches behavior of

function slug(input: string, options?: SlugOptions): string

Convert a string to a URL-safe slug

function slug(input: string, options?: SlugOptions): string

Convert a string to a URL-safe slug