> ## 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.

# RedactPIIEffect

# Function: redactPIIEffect()

> **redactPIIEffect**(`text`, `options?`): `Exit`\<`string`, `unknown`>

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

Redacts PII from text using Effect Schema validated options.

## Parameters

### text

`string`

The text to redact PII from.

### options?

Configuration options for redaction.

#### redactCreditCards?

`boolean`

#### redactDates?

`boolean`

#### redactEmails?

`boolean`

#### redactIPs?

`boolean`

#### redactPhones?

`boolean`

#### redactSSN?

`boolean`

## Returns

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

Exit containing redacted text or error.

## Compliance

NIST 800-53 AU-3 (Content of Audit Records)