Redacted

The Redacted module provides functionality for handling sensitive information securely within your application. By using the Redacted data type, you can ensure that sensitive values are not accidentally exposed in logs or error messages.

make

The Redacted.make function creates a Redacted<A> instance from a given value A, ensuring the content is securely hidden.

Example (Hiding Sensitive Information from Logs)

Using Redacted.make helps prevent sensitive information, such as API keys, from being accidentally exposed in logs or error messages.

1
import { Redacted, Effect } from "effect"
2

3
// Create a redacted API key
4
const API_KEY = Redacted.make("1234567890")
5

6
console.log(API_KEY)
7
// Output: {}
8

9
console.log(String(API_KEY))
10
// Output: <redacted>
11

12
Effect.runSync(Effect.log(API_KEY))
13
// Output: timestamp=... level=INFO fiber=#0 message="\"<redacted>\""

value

The Redacted.value function retrieves the original value from a Redacted instance. Use this function carefully, as it exposes the sensitive data, potentially making it visible in logs or accessible in unintended ways.

Example (Accessing the Underlying Sensitive Value)

1
import { Redacted } from "effect"
2

3
const API_KEY = Redacted.make("1234567890")
4

5
// Expose the redacted value
6
console.log(Redacted.value(API_KEY))
7
// Output: "1234567890"

unsafeWipe

The Redacted.unsafeWipe function erases the underlying value of a Redacted instance, making it inaccessible. This helps ensure that sensitive data does not remain in memory longer than needed.

Example (Wiping Sensitive Data from Memory)

1
import { Redacted } from "effect"
2

3
const API_KEY = Redacted.make("1234567890")
4

5
console.log(Redacted.value(API_KEY))
6
// Output: "1234567890"
7

8
Redacted.unsafeWipe(API_KEY)
9

10
console.log(Redacted.value(API_KEY))
11
/*
12
throws:
13
Error: Unable to get redacted value
14
*/

getEquivalence

The Redacted.getEquivalence function generates an Equivalence for Redacted<A> values using an Equivalence for the underlying values of type A. This allows you to compare Redacted values securely without revealing their content.

Example (Comparing Redacted Values)

1
import { Redacted, Equivalence } from "effect"
2

3
const API_KEY1 = Redacted.make("1234567890")
4
const API_KEY2 = Redacted.make("1-34567890")
5
const API_KEY3 = Redacted.make("1234567890")
6

7
const equivalence = Redacted.getEquivalence(Equivalence.string)
8

9
console.log(equivalence(API_KEY1, API_KEY2))
10
// Output: false
11

12
console.log(equivalence(API_KEY1, API_KEY3))
13
// Output: true