Skip to content

Custom Rules

  • maskText

    • Format: [matching pattern, replacement rule]
  • maskObject

    • Format: { "path.to.field": replacement_rule | handler_function }
    • Supports function handlers for dynamic masking

maskText

ts
maskText('123456', ['^(.*)(.{2})$', '{{*$1}}$2']);
// Preserves last 2 digits: ****56

maskText('123456', ['^(.{2})(.*)(.{2})$', '$1{{*$2}}$3']);
// Preserves first/last 2 digits, masks middle: 12**56

maskText('123456', ['^(.{2})(.*)(.{2})$', '$1***$3']);
// Preserves first/last 2 digits, fixed 3 asterisks: 12***56

maskText('123456', ['^(.*)$', '{{#$1}}']);
// Full masking with # symbol: ######

maskObject

ts
const sourceCustom = { firstCode: '123456' };
const config = {
  '^.*Code$': (value) => `*${value}*`, // Custom field handler
};
maskObject(sourceCustom, config);
// Output: { firstCode: '*123456*' }