[size]: https://packagephobia.now.sh/badge?p=@sanitise/html
[size-url]: https://packagephobia.now.sh/result?p=@sanitise/html

[![size][size]][size-url]

@sanitise/uri

🧼 Sanitise a URI to mitigate XSS and malformed URIs

Requirements

This module requires an Active LTS Node version (v14.15.0+).

Install

Using npm:

``console
npm install @sanitise/uri
`

Usage

`js
const { sanitise } = require('@sanitise/uri');

sanitise('http://bat.cave');
// → 'http://bat.cave'

sanitise(javascript:alert('joker'));
// → undefined
`

Falsey Results

This package follows the behavior of JSON.stringify. The following results for falsey values can be expected:

`js
sanitise(undefined);
// → undefined

sanitise(null);
// → 'null'

sanitise('');
// → ''
`

$3

$3

Type: String

Default: ''

Sets the default result value, should the uri` passed contain an invalid protocol.

Meta

CONTRIBUTING

LICENSE (MIT)