allow providing a custom name to Redacted

.changeset/short-monkeys-compete.md

@@ -0,0 +1,13 @@
+---
+"effect": minor
+---
+
+allow users to provide a custom name for Redacted values on creation
+
+```ts
+Redacted.make("1234567890", "API_KEY")
+```
+
+example logged output:
+
+level=INFO msg="permission granted" user=Perry token=API_KEY

packages/effect/src/Redacted.ts

@@ -65,12 +65,12 @@ export const isRedacted: (u: unknown) => u is Redacted<unknown> = redacted_.isRe
  * @example
  * import { Redacted } from "effect"
  *
- * const API_KEY = Redacted.make("1234567890")
+ * const API_KEY = Redacted.make("1234567890", "API_KEY")
  *
  * @since 3.3.0
  * @category constructors
  */
-export const make: <A>(value: A) => Redacted<A> = redacted_.make
+export const make: <A>(value: A, str?: string) => Redacted<A> = redacted_.make
 
 /**
  * Retrieves the original value from a `Redacted` instance. Use this function

packages/effect/src/internal/redacted.ts

@@ -29,15 +29,6 @@ export const proto = {
   pipe() {
     return pipeArguments(this, arguments)
   },
-  toString() {
-    return "<redacted>"
-  },
-  toJSON() {
-    return "<redacted>"
-  },
-  [NodeInspectSymbol]() {
-    return "<redacted>"
-  },
   [Hash.symbol]<T>(this: Redacted.Redacted<T>): number {
     return pipe(
       Hash.hash(RedactedSymbolKey),
@@ -54,8 +45,20 @@ export const proto = {
 export const isRedacted = (u: unknown): u is Redacted.Redacted<unknown> => hasProperty(u, RedactedTypeId)
 
 /** @internal */
-export const make = <T>(value: T): Redacted.Redacted<T> => {
-  const redacted = Object.create(proto)
+export const make = <T>(value: T, str = "<redacted>"): Redacted.Redacted<T> => {
+  const redacted = Object.create({
+    ...proto,
+      toString() {
+        return str
+      },
+      toJSON() {
+        return str
+      },
+      [NodeInspectSymbol]() {
+        return str
+      },
+    }
+  )
   redactedRegistry.set(redacted, value)
   return redacted
 }

packages/effect/test/Redacted.test.ts

@@ -29,11 +29,21 @@ describe("Redacted", () => {
     assert.strictEqual(`${redacted}`, "<redacted>")
   })
 
+  it("toString - custom string", () => {
+    const redacted = Redacted.make("redacted", "API_KEY")
+    assert.strictEqual(`${redacted}`, "API_KEY")
+  })
+
   it("toJSON", () => {
     const redacted = Redacted.make("redacted")
     assert.strictEqual(JSON.stringify(redacted), "\"<redacted>\"")
   })
 
+  it("toJSON - custom string", () => {
+    const redacted = Redacted.make("redacted", "API_KEY")
+    assert.strictEqual(JSON.stringify(redacted), "\"API_KEY\"")
+  })
+
   it("unsafeWipe", () => {
     const redacted = Redacted.make("redacted")
     assert.isTrue(Redacted.unsafeWipe(redacted))