Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vladkens/url-normalize
🔗🧹 Normalize URLs to a standardized form. HTTPS by default, flexible configuration, custom protocols, domain extraction, humazing URL, and punycode support. Both CJS & ESM modules available.
https://github.com/vladkens/url-normalize
cjs esm normalization normalizer npm-package punycode typescript url url-normalization url-normalizer
Last synced: about 1 month ago
JSON representation
🔗🧹 Normalize URLs to a standardized form. HTTPS by default, flexible configuration, custom protocols, domain extraction, humazing URL, and punycode support. Both CJS & ESM modules available.
- Host: GitHub
- URL: https://github.com/vladkens/url-normalize
- Owner: vladkens
- License: mit
- Created: 2023-05-13T22:41:16.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-09T17:24:27.000Z (about 1 month ago)
- Last Synced: 2024-11-09T18:26:13.246Z (about 1 month ago)
- Topics: cjs, esm, normalization, normalizer, npm-package, punycode, typescript, url, url-normalization, url-normalizer
- Language: TypeScript
- Homepage: https://npm.im/url-normalize
- Size: 157 KB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
- Codeowners: .github/codeowners
Awesome Lists containing this project
README
# url-normalize
[
](https://npmjs.org/package/url-normalize)
[
](https://packagephobia.now.sh/result?p=url-normalize)
[
](https://npmjs.org/package/url-normalize)
[
](https://github.com/vladkens/url-normalize/blob/main/LICENSE)
[
](https://buymeacoffee.com/vladkens)
**Normalize URLs** to a standardized form. **HTTPS** by default, flexible configuration, custom protocols, **domain extraction**, **humazing URL**, and **punycode** support. Both CJS & ESM modules available.
## Install
```sh
npm i url-normalize
```
```sh
yarn add url-normalize
```
## Usage
```typescript
import { urlNormalize } from "url-normalize"
urlNormalize("example.com")
// -> "https://example.com"
urlNormalize("//www.example.com:443/../foo/bar?b=2&a=1#tag")
// -> "https://example.com/foo/bar?a=1&b=2#tag"
// all invalid urls is null
urlNormalize("example")
// -> null
urlNormalize("data:content/type;base64,abc")
// -> null
urlNormalize("tel:+123456789")
// -> null
urlNormalize("mailto:[email protected]")
// -> null
```
## Configuration
### defaultProtocol `(default: https)`
Default supported protocols are: `http`, `https`
```typescript
urlNormalize("example.com", { defaultProtocol: "http" })
// -> "http://example.com"
urlNormalize("example.com", { defaultProtocol: "ftps" })
// -> ftps://example.com
// BUT keeps original protocol if it in url
urlNormalize("https://example.com", { defaultProtocol: "http" })
// -> "https://example.com"
```
### protocol `(default: true)`
```typescript
urlNormalize("https://example.com")
// -> "https://example.com"
urlNormalize("https://example.com", { protocol: false })
// -> "example.com"
urlNormalize("https://example.com/foo?bar=baz", { protocol: false })
// -> "example.com/foo?bar=baz"
```
### www `(default: false)`
```typescript
urlNormalize("www.example.com")
// -> "https://example.com"
urlNormalize("www.example.com", { www: true })
// -> "https://www.example.com"
```
### auth `(default: false)`
```typescript
urlNormalize("https://user:[email protected]")
// -> "https://example.com"
urlNormalize("https://user:[email protected]", { auth: true })
// -> "https://user:[email protected]"
```
### port `(default: false)`
```typescript
urlNormalize("https://example.com:8080")
// -> "https://example.com"
urlNormalize("https://example.com:8080", { port: true })
// -> "https://example.com:8080"
// BUT for HTTP - 80 & HTTPS - 443 always without port
urlNormalize("https://example.com:443", { port: true })
// -> "https://example.com"
```
### index `(default: true)`
```typescript
urlNormalize("example.com/index.html")
// -> "https://example.com/index.html"
urlNormalize("example.com/index.html", { index: false })
// -> "https://example.com"
```
### search `(default: true)`
```typescript
urlNormalize("example.com/?a=1&b=2")
// -> "https://example.com/?a=1&b=2"
urlNormalize("example.com/?a=1&b=2", { search: false })
// -> "https://example.com"
```
### sortSearch `(default: true)`
```typescript
urlNormalize("example.com/?b=2&b=1")
// -> "https://example.com/?a=1&b=2"
urlNormalize("example.com/?b=2&b=1", { sortSearch: false })
// -> "https://example.com/?b=2&b=1"
```
### filterSearch
```typescript
urlNormalize("example.com/?c=3&b=2&a=1", { filterSearch: (k, v) => k === "a" || v === "3" })
// -> https://example.com/?a=1&c=3
```
### fragment `(default: true)`
```typescript
urlNormalize("example.com/#foo")
// -> "https://example.com/#foo"
urlNormalize("example.com/?b=2&b=1", { fragment: false })
// -> "https://example.com"
```
### textFragment `(default: false)`
```typescript
urlNormalize("example.com/#:~:text=hello")
// -> "https://example.com"
urlNormalize("example.com/?b=2&b=1", { textFragment: true })
// -> "https://example.com/#:~:text=hello"
```
### customProtocol `(default: false)`
```typescript
urlNormalize("ftps://example.com")
// -> null
urlNormalize("tg://example.com")
// -> null
urlNormalize("ftps://example.com", { customProtocol: true })
// -> "ftps://example.com"
urlNormalize("tg://example.com", { customProtocol: true })
// -> "tg://example.com"
```
### forceProtocol
```typescript
urlNormalize("https://example.com", { forceProtocol: "sftp" })
// -> "sftp://example.com"
urlNormalize("tg://example.com", { forceProtocol: "we" })
// -> "we://example.com"
```
### unicode `(default: false)`
```typescript
urlNormalize("👻💥.ws")
// -> "https://xn--9q8huc.ws"
urlNormalize("👻💥.ws", { unicode: true })
// -> "https://👻💥.ws"
urlNormalize("https://xn--9q8huc.ws", { unicode: true })
// -> "https://👻💥.ws"
```
## Advanced
### createUrlNormalize
```typescript
import { createUrlNormalize } from "url-normalize"
const urlNormalize = createUrlNormalize({
defaultProtocol: "http",
fragment: false,
})
urlNormalize("example.com/foo#tag")
// -> "http://example.com/foo"
```
### urlNormalizeOrFail
```typescript
import { urlNormalize, urlNormalizeOrFail } from "url-normalize"
urlNormalize("invalid")
// -> null
urlNormalizeOrFail("invalid")
// throws Exception
```
### extractDomain
```typescript
import { extractDomain, extractDomainOrFail } from "url-normalize"
extractDomain("https://example.com:8080/?a=1&b=2#tag")
// -> "example.com"
extractDomain("invalid")
// -> null
extractDomainOrFail("invalid")
// throws Exception
```
### humanizeUrl
```typescript
import { humanizeUrl, humanizeUrlOrFail } from "url-normalize"
humanizeUrl("https://example.com/foo/bar")
// -> example.com/foo/bar
humanizeUrl("invalid")
// -> null
humanizeUrlOrFail("invalid")
// throws Exception
```
## Similar projects
- [sindresorhus/normalize-url](https://github.com/sindresorhus/normalize-url)