Slugify

import { slugify } from "@persian-tools/persian-tools";

slugify("سلام دنیا"); // "سلام-دنیا"
slugify("چگونه برنامه‌نویسی یاد بگیریم؟"); // "چگونه-برنامه-نویسی-یاد-بگیریم"
slugify("Hello سلام 2024"); // "hello-سلام-2024"

interface SlugifyOptions {
	separator?: string; // default "-"
	lowercase?: boolean; // default true (Latin only)
	removeRepeatedSeparators?: boolean; // default true
	maxLength?: number; // truncate after slug build
	preserveNumbers?: boolean; // default true
	customReplacements?: Record<string, string>;
}

slugify("سلام دنیا", { separator: "_" }); // "سلام_دنیا"
slugify("سلام دنیا", { maxLength: 8 }); // "سلام-دن"
slugify("سلام دنیا", { lowercase: false }); // doesn't lowercase Latin
slugify("سال ۱۴۰۰", { preserveNumbers: true }); // "سال-۱۴۰۰"

import { createSlug, slugifyWithNumbers, slugifySimple } from "@persian-tools/persian-tools";

createSlug("مقاله جدید"); // "مقاله-جدید"
createSlug("مقاله جدید", "_"); // "مقاله_جدید"
slugifyWithNumbers("سال ۱۴۰۰"); // keeps digits
slugifySimple("تست ساده"); // bare-bones, no options