artytext/dist/utils/slug.d.ts

A comprehensive utility library for text manipulation, slug generation, password generation, case conversion, and more. Works with both TypeScript and JavaScript.

import { SlugOptions } from '../types';
/**
 * Generate a URL-friendly slug from a string
 * @param text - Text to convert to slug
 * @param options - Slug generation options
 * @returns URL-friendly slug string
 */
export declare function generateSlug(text: string, options?: SlugOptions): string;
/**
 * Generate a slug with timestamp for unique URLs
 * @param text - Text to convert to slug
 * @param options - Slug generation options
 * @returns Unique slug with timestamp
 */
export declare function generateUniqueSlug(text: string, options?: SlugOptions): string;
/**
 * Generate a slug with random suffix for unique URLs
 * @param text - Text to convert to slug
 * @param options - Slug generation options
 * @param suffixLength - Length of random suffix (default: 6)
 * @returns Unique slug with random suffix
 */
export declare function generateRandomSlug(text: string, options?: SlugOptions, suffixLength?: number): string;
/**
 * Convert a slug back to readable text
 * @param slug - Slug to convert back
 * @param separator - Separator used in the slug (default: '-')
 * @returns Readable text
 */
export declare function slugToText(slug: string, separator?: string): string;
/**
 * Check if a string is a valid slug
 * @param slug - String to check
 * @param separator - Expected separator (default: '-')
 * @returns True if valid slug
 */
export declare function isValidSlug(slug: string, separator?: string): boolean;
//# sourceMappingURL=slug.d.ts.map