Install using npm or yarn:
npm i ufo
# or
yarn add ufoImport:
// CommonJS
const { normalizeURL, joinURL } = require('ufo')
// ESM
import { normalizeURL, joinURL } from 'ufo'Notice: You may need to transpile package and add URL polyfill for legacy environments
- Ensures URL is properly encoded
- Ensures pathname starts with slash
- Preserves protocol/host if provided
// Result: test?query=123%20123#hash,%20test
normalizeURL('test?query=123 123#hash, test')
// Result: http:https://localhost:3000/
normalizeURL('http:https://localhost:3000')// Result: a/b/c
joinURL('a', '/b', '/c')// Result: http:https://foo.com/foo/bar/baz?test=123#token
joinURL('http:https://foo.com/foo?test=123#token', 'bar', 'baz')// Result: /foo?page=a&token=secret
withQuery('/foo?page=a', { token: 'secret' })// Result: { test: '123', unicode: '好' }
getQuery('http:https://foo.com/foo?test=123&unicode=%E5%A5%BD')Implementing URL interface with some improvements:
- Supporting schemeless and hostless URLs
- Supporting relative URLs
- Preserving trailing-slash status
- Decoded and mutable classs properties (
protocol,host,auth,pathname,query,hash) - Consistent URL parser independent of environment
- Consistent encoding independent of environment
- Punycode support for host encoding
Ensures url ends with a trailing slash
// Result: /foo/
withTrailingSlash('/foo')Ensures url does not ends with a trailing slash
// Result: /foo
withoutTrailingSlash('/foo/')Ensures url does not have double slash (except for protocol)
// Result: /foo/bar/
cleanDoubleSlashes('//foo//bar//')
// Result: http:https://example.com/analyze/http:https://localhost:3000/
cleanDoubleSlashes('http:https://example.com/analyze//http:https://localhost:3000//')Special thanks to Eduardo San Martin Morote (posva) for encoding utlities