Class Masquerade

Description

Masquerade provides functionality to redact sensitive info.

Example

import { Masquerade } from '@biorate/masquerade';

Masquerade.configure({ maskJSON2: { emailFields: ['email'] } });

const result = Masquerade.processJSON({ email: 'test@email.com' });

console.log(result); // { "email": "tes*@*******om" }
import { Masquerade } from '@biorate/masquerade';

Masquerade.use(EmailMask).use(PhoneMask).use(CardMask);

const result = Masquerade.processString(
`user@example.com, +79231231224, 4111 1111 1111 1111 (Visa), 5500-0000-0000-0004 (MC)`
);

console.log(result); // u***@**********m, +*******1224, **** **** **** 1111 (Visa), ****-****-****-0004 (MC)

Hierarchy

  • Masquerade

Constructors

Properties

config: IConfig
config: {
    CardMask?: ICardMaskOptions;
    EmailMask?: IEmailMaskOptions;
    PhoneMask?: IPhoneMaskOptions;
    maskJSON2?: JsonMask2Configs;
} = {}

Type declaration

  • Optional CardMask?: ICardMaskOptions
  • Optional EmailMask?: IEmailMaskOptions
  • Optional PhoneMask?: IPhoneMaskOptions
  • Optional maskJSON2?: JsonMask2Configs
maskers: Map<string, CommonMask> = ...

Accessors

Methods

  • Parameters

    • config: {
          CardMask?: ICardMaskOptions;
          EmailMask?: IEmailMaskOptions;
          PhoneMask?: IPhoneMaskOptions;
          maskJSON2?: JsonMask2Configs;
      }
      • Optional CardMask?: ICardMaskOptions
      • Optional EmailMask?: IEmailMaskOptions
      • Optional PhoneMask?: IPhoneMaskOptions
      • Optional maskJSON2?: JsonMask2Configs

    Returns typeof Masquerade

Generated using TypeDoc