Skip to content

Commit 471cf94

Browse files
github-actions[bot]hckhanh
authored andcommitted
Bump version package
1 parent bc54816 commit 471cf94

File tree

3 files changed

+49
-47
lines changed

3 files changed

+49
-47
lines changed

.changeset/jsr-compliance-and-rename.md

Lines changed: 0 additions & 46 deletions
This file was deleted.

CHANGELOG.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,53 @@
11
# fast-url
22

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+
351
## 5.0.1
452

553
### Patch Changes

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "fast-url",
33
"description": "A folk version of the `urlcat` library focus on performance and simplicity.",
4-
"version": "5.0.1",
4+
"version": "6.0.0",
55
"author": {
66
"name": "Khánh Hoàng",
77
"email": "hi@khanh.id",

0 commit comments

Comments
 (0)