The ufo npm package provides utilities for URL formatting and normalization. It helps in parsing, resolving, and normalizing URLs, as well as providing utilities for handling query parameters.
Parsing and normalizing URLs
This feature allows you to normalize URLs, which includes removing the default port for HTTP and HTTPS, decoding unnecessary percent-encoded characters, and removing duplicate slashes.
const { normalizeURL } = require('ufo');
const normalizedUrl = normalizeURL('http://example.com:80/path/');Handling query parameters
This feature enables you to easily add query parameters to a URL, which can be useful for constructing URLs with dynamic query strings.
const { withQuery } = require('ufo');
const urlWithQuery = withQuery('http://example.com', { query: 'value' });Joining URLs
This feature is used to concatenate URL parts safely, ensuring that there are no duplicate slashes and that the query string is properly appended.
const { joinURL } = require('ufo');
const fullUrl = joinURL('http://example.com', '/path', '?query=value');The url-parse package offers similar URL parsing and manipulation functionalities. It provides a more detailed breakdown of the URL components and can be used in both Node.js and browser environments, whereas ufo is more focused on URL normalization and handling.
The qs package is used for parsing and stringifying query strings. It goes into more depth for handling nested objects within query strings compared to ufo's simpler query parameter utilities.
URI.js is a URL mutation library that offers comprehensive URL manipulation capabilities. It has a fluent API for building and altering URL components, which might be more intuitive for some developers compared to ufo's more functional approach.
URL utils for humans.
Install using npm or your favourite package manager:
npm i ufo
Import:
// CommonJS
const { normalizeURL, joinURL } = require('ufo')
// ESM
import { normalizeURL, joinURL } from 'ufo'
// Deno
import { parseURL } from 'https://unpkg.com/ufo/dist/index.mjs'
Notice: You may need to transpile package and add URL polyfill for legacy environments
normalizeURLnormalizeURL('test?query=123 123#hash, test')
// test?query=123%20123#hash,%20test
normalizeURL('http://localhost:3000')
// http://localhost:3000/
joinURLjoinURL('a', '/b', '/c')
// a/b/c
resolveURLresolveURL('http://foo.com/foo?test=123#token', 'bar', 'baz')
// http://foo.com/foo/bar/baz?test=123#token
parseURLparseURL('http://foo.com/foo?test=123#token')
// { protocol: 'http:', auth: '', host: 'foo.com', pathname: '/foo', search: '?test=123', hash: '#token' }
parseURL('foo.com/foo?test=123#token')
// { pathname: 'foo.com/foo', search: '?test=123', hash: '#token' }
parseURL('foo.com/foo?test=123#token', 'https://')
// { protocol: 'https:', auth: '', host: 'foo.com', pathname: '/foo', search: '?test=123', hash: '#token' }
stringifyParsedURLconst obj = parseURL('http://foo.com/foo?test=123#token')
obj.host = 'bar.com'
stringifyParsedURL(obj)
// http://bar.com/foo?test=123#token
withQuerywithQuery('/foo?page=a', { token: 'secret' })
// /foo?page=a&token=secret
getQuerygetQuery('http://foo.com/foo?test=123&unicode=%E5%A5%BD')
// { test: '123', unicode: '好' }
parseFilename// Result: filename.ext
parseFilename('http://example.com/path/to/filename.ext')
// Result: undefined
parseFilename('/path/to/.hidden-file', { strict: true })
$URLImplementing URL interface with improvements:
protocol, host, auth, pathname, query, hash)new $URL('http://localhost:3000/hello?world=true')
// { protocol: 'http:', host: 'localhost:3000', auth: '', pathname: '/hello', query: { world: 'true' }, hash: '' }
withTrailingSlashEnsures url ends with a trailing slash.
withTrailingSlash('/foo')
// /foo/
Set the second option to true to support query parameters:
withTrailingSlash('/path?query=true', true)
// /path/?query=true
withoutTrailingSlashEnsures url does not ends with a trailing slash.
withoutTrailingSlash('/foo/')
// /foo
Set the second option to true to support query parameters:
withoutTrailingSlash('/path/?query=true', true)
// /path?query=true
cleanDoubleSlashesEnsures url does not have double slash (except for protocol).
cleanDoubleSlashes('//foo//bar//')
// /foo/bar/
cleanDoubleSlashes('http://example.com/analyze//http://localhost:3000//')
// http://example.com/analyze/http://localhost:3000/
isSamePathCheck two paths are equal or not. Trailing slash and encoding are normalized before comparation.
isSamePath('/foo', '/foo/')
// true
isRelativeCheck if a path starts with ./ or ../.
isRelative('./foo')
// true
withHttpEnsures url protocol is http
withHttp('https://example.com')
// http://example.com
withHttpsEnsures url protocol is https
withHttps('http://example.com')
// https://example.com
withProtocolChanges url protocol passed as second argument
withProtocol('http://example.com', 'ftp://')
// ftp://example.com
withoutProtocolRemoves url protocol
withoutProtocol('http://example.com')
// example.com
isEqualCompare two URLs regardless of their slash condition or encoding:
isEqual('/foo', 'foo')
// true
isEqual('foo/', 'foo')
// true
isEqual('/foo bar', '/foo%20bar')
// true
// Strict compare
isEqual('/foo', 'foo', { leadingSlash: true })
// false
isEqual('foo/', 'foo', { trailingSlash: true })
// false
isEqual('/foo bar', '/foo%20bar', { encoding: true })
// false
Special thanks to Eduardo San Martin Morote (posva) for encoding utlities
v1.2.0
isScriptProtocol util (#156)getQuery and parseQuery (#131)parseFilename utility (#125).github/workflows dir (f1b3d5c)FAQs
URL utils for humans
The npm package ufo receives a total of 7,390,627 weekly downloads. As such, ufo popularity was classified as popular.
We found that ufo demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.
Security News
Research
The Socket Research Team uncovered a malicious Python package typosquatting the popular 'fabric' SSH library, silently exfiltrating AWS credentials from unsuspecting developers.