effect-io-ai

Package: effect
Module: Redacted

Redacted.isRedacted

Returns true if a value is a Redacted wrapper.

When to use

Use to validate unknown input and narrow it to Redacted.

Details

When this function returns true, TypeScript narrows the value to Redacted<unknown>.

Example (Checking for redacted values)

import { Redacted } from "effect"

const secret = Redacted.make("my-secret")
const plainString = "not-secret"

console.log(Redacted.isRedacted(secret)) // true
console.log(Redacted.isRedacted(plainString)) // false

Signature

declare const isRedacted: (u: unknown) => u is Redacted<unknown>

Source

Since v3.3.0