@npmcli/redact

Redact sensitive information

This feature allows you to redact specified sensitive information from a string. In this example, the words 'password' and 'secret' are redacted.

const { create } = require('@npmcli/redact');
const redactor = create(['password', 'secret']);
const redactedString = redactor('My password is password and my secret is secret.');
console.log(redactedString); // Output: My ****** is ****** and my ****** is ******.

Custom redaction patterns

This feature allows you to use custom regular expressions to define what should be redacted. In this example, a pattern for credit card numbers is used.

const { create } = require('@npmcli/redact');
const redactor = create([/\b\d{4}-\d{4}-\d{4}-\d{4}\b/]);
const redactedString = redactor('My credit card number is 1234-5678-1234-5678.');
console.log(redactedString); // Output: My credit card number is ********************.

Redact multiple patterns

This feature allows you to redact multiple patterns at once. In this example, both the word 'password' and a credit card number pattern are redacted.

const { create } = require('@npmcli/redact');
const redactor = create(['password', /\b\d{4}-\d{4}-\d{4}-\d{4}\b/]);
const redactedString = redactor('My password is password and my credit card number is 1234-5678-1234-5678.');
console.log(redactedString); // Output: My ****** is ****** and my credit card number is ********************.