arcjet
</picture>
@arcjet/redact
</picture>
Arcjet helps developers protect their apps in just a few lines of code. Implement rate limiting, bot protection, email verification, and defense against common attacks.
This is the Arcjet TypeScript and JavaScript sensitive information redaction library.
What is this?
This package provides functionality to redact sensitive info. The work is done in WebAssembly but is called here from JavaScript.
The WebAssembly files are in @arcjet/redact-wasm.
For more info on why we maintain our WebAssembly and JavaScript projects like
this,
see “What is this?” in the readme of
@arcjet/analyze-wasm.
When should I use this?
You can use this package to redact sensitive information locally. You can redact email addresses, credit card numbers, and more. It is also possible to reverse the process: to un-redact what was found.
Install
This package is ESM only. Install with npm in Node.js:
npm install @arcjet/redact
Reference
The full reference documentation can be found in the Arcjet docs.
Use
import { redact } from "@arcjet/redact";
const value = "Hi, my name is John and my email adress is john@example.com";
const [redacted, unredact] = await redact(value, {
entities: ["email", "phone-number"],
});
console.log(redacted);
// => "Hi, my name is John and my email adress is <Redacted email #0>"
const unredacted = unredact("Your email address is <Redacted email #0>");
console.log(unredacted); // "Your email address is john@example.com"