micromark utility to sanitize urls
npm install micromark-util-sanitize-uri[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][bundle-size-badge]][bundle-size]
[![Sponsors][sponsors-badge]][opencollective]
[![Backers][backers-badge]][opencollective]
[![Chat][chat-badge]][chat]
[micromark][] utility to sanitize urls.
* What is this?
* When should I use this?
* Install
* Use
* API
* normalizeUri(value)
* [sanitizeUri(url[, pattern])](#sanitizeuriurl-pattern)
* Types
* Compatibility
* Security
* Contribute
* License
This package exposes an algorithm to make URLs safe.
This package might be useful when you are making your own micromark extensions.
This package is [ESM only][esm].
In Node.js (version 16+), install with [npm][]:
``sh`
npm install micromark-util-sanitize-uri
In Deno with [esm.sh][esmsh]:
`js`
import {sanitizeUri} from 'https://esm.sh/micromark-util-sanitize-uri@1'
In browsers with [esm.sh][esmsh]:
`html`
`js
import {sanitizeUri} from 'micromark-util-sanitize-uri'
sanitizeUri('https://example.com/a&b') // 'https://example.com/a&b'
sanitizeUri('https://example.com/a%b') // 'https://example.com/a%25b'
sanitizeUri('https://example.com/a%20b') // 'https://example.com/a%20b'
sanitizeUri('https://example.com/👍') // 'https://example.com/%F0%9F%91%8D'
sanitizeUri('https://example.com/', /^https?$/i) // 'https://example.com/'
sanitizeUri('javascript:alert(1)', /^https?$/i) // ''
sanitizeUri('./example.jpg', /^https?$/i) // './example.jpg'
sanitizeUri('#a', /^https?$/i) // '#a'
`
This module exports the identifiers [normalizeUri][api-normalize-uri] andsanitizeUri
[][api-sanitize-uri].
There is no default export.
Normalize a URL.
Encode unsafe characters with percent-encoding, skipping already encoded
sequences.
###### Parameters
* value (string)
— URI to normalize
###### Returns
Normalized URI (string).
Make a value safe for injection as a URL.
This encodes unsafe characters with percent-encoding and skips already
encoded sequences (see [normalizeUri][api-normalize-uri]).micromark-util-encode
Further unsafe characters are encoded as character references (see
[][micromark-util-encode]).
A regex of allowed protocols can be given, in which case the URL is sanitized.
For example, /^(https?|ircs?|mailto|xmpp)$/i can be used for a[href], or/^https?$/i for img[src] (this is what github.com allows).protocol
If the URL includes an unknown protocol (one not matched by , suchjavascript:
as a dangerous example, ), the value is ignored.
###### Parameters
* url (string)pattern
— URI to sanitize
* (RegExp, optional)
— allowed protocols
###### Returns
Sanitized URI (string).
This package is fully typed with [TypeScript][].
It exports no additional types.
Projects maintained by the unified collective are compatible with maintained
versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line,
micromark-util-sanitize-uri@2, compatible with Node.js 16.micromark@3
This package works with .
This package is safe.
See [security.md][securitymd] in [micromark/.github][health] for how to
submit a security report.
See [contributing.md][contributing] in [micromark/.github][health] for wayssupport.md`][support] for ways to get help.
to get started.
See [
This project has a [code of conduct][coc].
By interacting with this repository, organisation, or community you agree to
abide by its terms.
[MIT][license] © [Titus Wormer][author]
[build-badge]: https://github.com/micromark/micromark/workflows/main/badge.svg
[build]: https://github.com/micromark/micromark/actions
[coverage-badge]: https://img.shields.io/codecov/c/github/micromark/micromark.svg
[coverage]: https://codecov.io/github/micromark/micromark
[downloads-badge]: https://img.shields.io/npm/dm/micromark-util-sanitize-uri.svg
[downloads]: https://www.npmjs.com/package/micromark-util-sanitize-uri
[bundle-size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=micromark-util-sanitize-uri
[bundle-size]: https://bundlejs.com/?q=micromark-util-sanitize-uri
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
[backers-badge]: https://opencollective.com/unified/backers/badge.svg
[opencollective]: https://opencollective.com/unified
[npm]: https://docs.npmjs.com/cli/install
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[esmsh]: https://esm.sh
[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
[chat]: https://github.com/micromark/micromark/discussions
[license]: https://github.com/micromark/micromark/blob/main/license
[author]: https://wooorm.com
[health]: https://github.com/micromark/.github
[securitymd]: https://github.com/micromark/.github/blob/main/security.md
[contributing]: https://github.com/micromark/.github/blob/main/contributing.md
[support]: https://github.com/micromark/.github/blob/main/support.md
[coc]: https://github.com/micromark/.github/blob/main/code-of-conduct.md
[typescript]: https://www.typescriptlang.org
[micromark]: https://github.com/micromark/micromark
[micromark-util-encode]: https://github.com/micromark/micromark/tree/main/packages/micromark-util-encode
[api-normalize-uri]: #normalizeurivalue
[api-sanitize-uri]: #sanitizeuriurl-pattern