@armand__/core
v0.0.1
Published
Une bibliothèque TypeScript légère et universelle offrant des utilitaires essentiels pour **Node.js** et le **Navigateur**.
Readme
@armand__/typescript-utils
Une bibliothèque TypeScript légère et universelle offrant des utilitaires essentiels pour Node.js et le Navigateur.
✨ Caractéristiques
- Universelle : Support complet de ESM (ECMAScript Modules) et CommonJS.
- Type Safe : Écrit entièrement en TypeScript avec des définitions de types incluses.
- Légère : Zéro dépendance externe.
- Optimisée : Tree-shaking supporté et fichiers minifiés.
🚀 Installation
npm install @armand__/typescript-utils
# ou
yarn add @armand__/typescript-utils
# ou
pnpm add @armand__/typescript-utils
📖 Utilisation
Dans le Navigateur (Vite, Webpack, etc.) ou Node.js (ESM)
import { slugify } from '@armand__/typescript-utils';
const title = "Mon Super Article !";
console.log(slugify(title)); // "mon-super-article"
Dans Node.js (CommonJS)
const { slugify } = require('@armand__/typescript-utils');
console.log(slugify("Hello World")); // "hello-world"
🛠 API
slugify(text: string): string
Transforme une chaîne de caractères en un slug URL-friendly.
- Supprime les accents.
- Remplace les espaces par des tirets.
- Supprime les caractères spéciaux.
🧪 Développement
Si vous souhaitez contribuer ou tester la bibliothèque localement :
# Installer les dépendances
npm install
# Lancer les tests unitaires (Vitest)
npm run test
# Lancer le build de production
npm run build
📄 Licence
Distribué sous la licence MIT. Voir LICENSE pour plus d'informations.
