> ## Documentation Index
> Fetch the complete documentation index at: https://resq-dependabot-github-actions-github-actions-478e18be3d.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# SanitizeUrlEffect

# Function: sanitizeUrlEffect()

> **sanitizeUrlEffect**(`url`, `allowedProtocols?`): `Exit`\<`string`, `unknown`>

Defined in: [sanitize.ts:188](https://github.com/resq-software/npm/blob/fe2e20ae9db8398a0db1e3218edaabb3cf7004d6/packages/security/src/sanitize.ts#L188)

Validates and sanitizes a user-supplied URL using Effect Schema.
Returns an Exit with the sanitized URL or an error.

## Parameters

### url

`string`

The URL to be validated and sanitized.

### allowedProtocols?

readonly `string`\[] = `...`

Array of allowed URL protocols.

## Returns

`Exit`\<`string`, `unknown`>

Exit containing the sanitized URL or an error.

## Compliance

NIST 800-53 SI-10 (Information Input Validation)

## Example

```typescript theme={null}
const result = sanitizeUrlEffect('https://example.com');
// Exit.succeed('https://example.com')

const invalid = sanitizeUrlEffect('javascript:alert(1)');
// Exit.fail(...)
```