\n
![\"Markdownify\"](\"docs/cat.svg\")
\n \n urlcat\n
\n
\n \n \n ![\"Build](\"https://github.com/balazsbotond/urlcat/actions/workflows/ci.yml/badge.svg\"\n){kind=icon}
\n \n \n ![\"npm](\"https://img.shields.io/npm/v/urlcat.svg?style=flat\")
\n \n \n \n \n \n
![\"Coverage](\"https://coveralls.io/repos/github/balazsbotond/urlcat/badge.svg?branch=master\"){kind=icon}
\n \n
\n What? •\n Why? •\n How? •\n TypeScript •\n API •\n Help •\n Contribute\n
\n\n## What?\n\n*urlcat* is a tiny JavaScript library that makes building URLs very convenient and prevents common mistakes.\n\n\n ![](\"docs/urlcat-basic-usage.svg#gh-light-mode-only\")
\n ![](\"docs/urlcat-basic-usage-dark.svg#gh-dark-mode-only\")
\n
urlcat('https://api.example.com', '/users/:id/posts', { id: 123, limit: 10, offset: 120 })'https://api.example.com/users/123/posts?limit=10&offset=120'\n urlcat('http://example.com/', '/posts/:title', { title: 'Letters & \"Special\" Characters' })'http://example.com/posts/Letters%20%26%20%22Special%22%20Characters'\n urlcat('https://api.example.com', '/users')'https://api.example.com/users'\n urlcat('https://api.example.com/', '/users')'https://api.example.com/users'\n urlcat('http://example.com/', '/users/:userId/posts/:postId/comments', { userId: 123, postId: 987, authorId: 456, limit: 10, offset: 120 })'http://example.com/users/123/posts/987/comments?authorId=456&limit=10&offset=120'\n params | result |
|---|---|
{} | '' |
{ query: 'some text' } | 'query=some%20text' |
{ id: 42, 'comment-id': 86 } | 'id=42&comment-id=86' |
{ id: 42, 'a name': 'a value' } | 'id=42&a%20name=a%20value' |
template | params | result |
|---|---|---|
':id' | { id: 42 } | '42' |
'/users/:id' | { id: 42 } | '/users/42' |
'/users/:id/comments/:commentId' | { id: 42, commentId: 86 } | '/users/42/comments/86' |
'/users/:id' | { id: 42, foo: 'bar' } | '/users/42' |
part1 | separator | part2 | result |
|---|---|---|---|
'first' | ',' | 'second' | 'first,second' |
'first,' | ',' | 'second' | |
'first' | ',' | ',second' | |
'first,' | ',' | ',second' |
![\"\"/](\"https://avatars2.githubusercontent.com/u/2791280?v=4\") Botond Balázs 💻 ⚠️ 📖 🚇 🐛 🚧 | \n ![\"\"/](\"https://avatars0.githubusercontent.com/u/3541096?v=4\") kako-jun 🐛 🤔 | \n ![\"\"/](\"https://avatars1.githubusercontent.com/u/722173?v=4\") Kim Kyudeok 🤔 | \n ![\"\"/](\"https://avatars3.githubusercontent.com/u/45915468?v=4\") Harshil Parmar 💻 | \n ![\"\"/](\"https://avatars0.githubusercontent.com/u/174864?v=4\") Ken Powers 📦 📓 | \n ![\"\"/](\"https://avatars3.githubusercontent.com/u/30530587?v=4\") Praveen K B 🤔 📖 | \n ![\"\"/](\"https://avatars0.githubusercontent.com/u/5228711?v=4\") Khizar Iqbal 🤔 🚇 | \n
![\"\"/](\"https://avatars2.githubusercontent.com/u/10977475?v=4\") Simon Jang 🤔 💻 | \n ![\"\"/](\"https://avatars0.githubusercontent.com/u/2239547?v=4\") Luyu Cheng 📖 | \n ![\"\"/](\"https://avatars0.githubusercontent.com/u/149248?v=4\") Christian Rackerseder 📖 | \n ![\"\"/](\"https://avatars3.githubusercontent.com/u/42470695?v=4\") Aryan Gupta 📖 | \n ![\"\"/](\"https://avatars3.githubusercontent.com/u/46860?v=4\") Jason Kohles 🐛 💻 | \n ![\"\"/](\"https://avatars2.githubusercontent.com/u/10531605?v=4\") Tiago Santos Da Silva 💻 | \n ![\"\"/](\"https://avatars0.githubusercontent.com/u/8659099?v=4\") Tom 💻 🚇 | \n
![\"\"/](\"https://avatars1.githubusercontent.com/u/13049630?v=4\") Drishit Mitra 🚇 | \n ![\"\"/](\"https://avatars3.githubusercontent.com/u/51375116?v=4\") Sakshi Vattikuti 📖 | \n ![\"\"/](\"https://avatars3.githubusercontent.com/u/19320956?v=4\") 3zk1m0 🤔 | \n ![\"\"/](\"https://avatars1.githubusercontent.com/u/3200580?v=4\") David Joseph Guzsik 👀 | \n
\n \n \n \n \n \n \n \n \n \n \n \n
\n \n
\n What? •\n Why? •\n How? •\n TypeScript •\n API •\n Help •\n Contribute\n
\n\n## What?\n\n*urlcat* is a tiny JavaScript library that makes building URLs very convenient and prevents common mistakes.\n\n\n \n \n
urlcat('https://api.example.com', '/users/:id/posts', { id: 123, limit: 10, offset: 120 })'https://api.example.com/users/123/posts?limit=10&offset=120'\n urlcat('http://example.com/', '/posts/:title', { title: 'Letters & \"Special\" Characters' })'http://example.com/posts/Letters%20%26%20%22Special%22%20Characters'\n urlcat('https://api.example.com', '/users')'https://api.example.com/users'\n urlcat('https://api.example.com/', '/users')'https://api.example.com/users'\n urlcat('http://example.com/', '/users/:userId/posts/:postId/comments', { userId: 123, postId: 987, authorId: 456, limit: 10, offset: 120 })'http://example.com/users/123/posts/987/comments?authorId=456&limit=10&offset=120'\n params | result |
|---|---|
{} | '' |
{ query: 'some text' } | 'query=some%20text' |
{ id: 42, 'comment-id': 86 } | 'id=42&comment-id=86' |
{ id: 42, 'a name': 'a value' } | 'id=42&a%20name=a%20value' |
template | params | result |
|---|---|---|
':id' | { id: 42 } | '42' |
'/users/:id' | { id: 42 } | '/users/42' |
'/users/:id/comments/:commentId' | { id: 42, commentId: 86 } | '/users/42/comments/86' |
'/users/:id' | { id: 42, foo: 'bar' } | '/users/42' |
part1 | separator | part2 | result |
|---|---|---|---|
'first' | ',' | 'second' | 'first,second' |
'first,' | ',' | 'second' | |
'first' | ',' | ',second' | |
'first,' | ',' | ',second' |
Botond Balázs 💻 ⚠️ 📖 🚇 🐛 🚧 | \n kako-jun 🐛 🤔 | \n Kim Kyudeok 🤔 | \n Harshil Parmar 💻 | \n Ken Powers 📦 📓 | \n Praveen K B 🤔 📖 | \n Khizar Iqbal 🤔 🚇 | \n
Simon Jang 🤔 💻 | \n Luyu Cheng 📖 | \n Christian Rackerseder 📖 | \n Aryan Gupta 📖 | \n Jason Kohles 🐛 💻 | \n Tiago Santos Da Silva 💻 | \n Tom 💻 🚇 | \n
Drishit Mitra 🚇 | \n Sakshi Vattikuti 📖 | \n 3zk1m0 🤔 | \n David Joseph Guzsik 👀 | \n