enhanced-url
v1.0.0
Published
A library for parsing URL path parameters
Readme
EnhancedURL
EnhancedURL es una extensión sencilla del objeto URL nativo de JavaScript que facilita la gestión de path parameters en las rutas. Con esta biblioteca, puedes extraer y manipular parámetros de forma intuitiva, mejorando así la legibilidad y mantenibilidad de tu código.
Características
- Extensión del objeto URL: Añade funcionalidades adicionales al objeto
URLnativo. - Objeto URLPathParams: Implementa el objeto
URLPathParamsheredando del objetoMap<string, string>inspirado en el objeto nativoURLSearchParams, permitiendo extraer y manipular parámetros de ruta a partir de una plantilla. - Manejo de path parameters: Extrae parámetros de ruta de manera sencilla usando plantillas.
- Inmutabilidad: Los parámetros son inmutables desde el exterior, protegiendo la integridad de tus datos.
- Compatibilidad con ECMAScript Modules: Utiliza la sintaxis estándar de módulos de JavaScript.
Instalación
Puedes instalar el paquete a través de npm:
npm install enhanced-urlUso
Crear una instancia de EnhancedURL
import { EnhancedURL } from 'enhanced-url';
const url = new EnhancedURL('https://pokeapi.co/api/v2/pokemon/ditto');Obtener parámetros de ruta
const template = '/api/:apiVersion/pokemon/:name';
const params = url.getPathParams(template);
console.log(params.toObject()); // { apiVersion: 'v2', name: 'ditto' }Estructura del proyecto
64.0 KiB enhanced-url/
4.0 KiB ├── README.md
4.0 KiB ├── index.d.ts
36.0 KiB ├── package-lock.json
4.0 KiB ├── package.json
12.0 KiB ├── src/
4.0 KiB │ ├── enhanced-url.js
4.0 KiB │ ├── index.js
4.0 KiB │ └── url-path-params.js
8.0 KiB └── tests/
4.0 KiB ├── enhanced-url.test.js
4.0 KiB └── url-path-params.test.js
2 directories, 9 filesPruebas
Para ejecutar las pruebas incluidas, asegúrate de tener Vitest instalado y luego ejecuta:
npm run testContribuciones
Las contribuciones son bienvenidas. Siéntete libre de abrir un issue o enviar un pull request.
Licencia
Este proyecto está bajo la MIT License.
