[Arcjet][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][arcjet] TypeScript and JavaScript sensitive information
redaction library.
## Installation
```shell
npm install -S @arcjet/redact
```
## Reference
The full reference documentation can be found in the [Arcjet docs][redact-ref].
## Example
```typescript
const text = "Hi, my name is John and my email adress is john@example.com";
const [redacted, unredact] = await redact(text, {
redact: ["email", "phone-number"],
});
console.log(redacted);
// Hi, my name is John and my email address is
const unredacted = unredact("Your email address is ");
console.log(unredacted); // Your email address is john@example.com
```
## License
Licensed under the [Apache License, Version 2.0][apache-license].
[arcjet]: https://arcjet.com
[redact-ref]: https://docs.arcjet.com/redact/reference
[apache-license]: http://www.apache.org/licenses/LICENSE-2.0
