|
1 | 1 | # fast-url |
2 | 2 |
|
| 3 | +## 6.0.0 |
| 4 | + |
| 5 | +### Major Changes |
| 6 | + |
| 7 | +- d14ac79: **BREAKING CHANGE**: Renamed default export from `urlcat` to `createUrl` and changed from default export to named export for better clarity and JSR.io compliance |
| 8 | + |
| 9 | + ### JSR.io Compliance |
| 10 | + |
| 11 | + Made the package fully compliant with JSR.io (JavaScript Registry) requirements: |
| 12 | + |
| 13 | + - Added comprehensive module documentation to all entrypoints with `@module` tags |
| 14 | + - Added JSDoc documentation for all exported symbols (100% coverage) |
| 15 | + - Added usage examples in module documentation |
| 16 | + - Enhanced TypeScript type safety with proper documentation for `ParamMap` type |
| 17 | + - Verified no slow types are used (strict mode enabled) |
| 18 | + |
| 19 | + ### Breaking Changes |
| 20 | + |
| 21 | + - **Renamed**: Function changed from `urlcat` to `createUrl` |
| 22 | + - **Export Type**: Changed from default export to named export |
| 23 | + |
| 24 | + ```typescript |
| 25 | + // Before |
| 26 | + import urlcat from "fast-url"; |
| 27 | + urlcat("https://api.example.com", "/users/:id", { id: 42 }); |
| 28 | + |
| 29 | + // After |
| 30 | + import { createUrl } from "fast-url"; |
| 31 | + createUrl("https://api.example.com", "/users/:id", { id: 42 }); |
| 32 | + ``` |
| 33 | + |
| 34 | + ### Migration Guide |
| 35 | + |
| 36 | + Update your imports and function calls: |
| 37 | + |
| 38 | + 1. Replace `import urlcat from 'fast-url'` with `import { createUrl } from 'fast-url'` |
| 39 | + 2. Replace all `urlcat(...)` calls with `createUrl(...)` |
| 40 | + 3. For CommonJS: Replace `const urlcat = require('fast-url').default` with `const { createUrl } = require('fast-url')` |
| 41 | + |
| 42 | + The API and all utility functions (`query`, `subst`, `join`) remain unchanged and fully compatible. |
| 43 | + |
| 44 | + ### Documentation Improvements |
| 45 | + |
| 46 | + - Enhanced JSDoc comments with better examples |
| 47 | + - Added module-level documentation for better IDE support |
| 48 | + - Improved type definitions for JSR.io compatibility |
| 49 | + - All exported symbols now have comprehensive documentation |
| 50 | + |
3 | 51 | ## 5.0.1 |
4 | 52 |
|
5 | 53 | ### Patch Changes |
|
0 commit comments