API Reference
    Preparing search index...
    MaskingRule:
        | {
            customMask?: never;
            dynamicMask?: never;
            maskFormat: string;
            regexPattern: RegExp;
        }
        | {
            customMask?: never;
            dynamicMask: true;
            maskFormat?: never;
            regexPattern?: never;
        }
        | {
            customMask: string;
            dynamicMask?: never;
            maskFormat?: never;
            regexPattern?: never;
        }
        | {
            customMask?: never;
            dynamicMask?: never;
            maskFormat?: never;
            regexPattern?: never;
        }

    Per-field custom masking configuration for DataMasking.erase.

    The masking strategies are mutually exclusive: provide regexPattern together with maskFormat, or dynamicMask, or customMask, or an empty rule ({}) for the default mask value.

    Type Declaration

    • {
          customMask?: never;
          dynamicMask?: never;
          maskFormat: string;
          regexPattern: RegExp;
      }
      • OptionalcustomMask?: never
      • OptionaldynamicMask?: never
      • maskFormat: string

        Replacement format string (e.g., '$1****$3').

      • regexPattern: RegExp

        Regex pattern to match within the field value.

    • {
          customMask?: never;
          dynamicMask: true;
          maskFormat?: never;
          regexPattern?: never;
      }
      • OptionalcustomMask?: never
      • dynamicMask: true

        If true, the mask length matches the original value length.

      • OptionalmaskFormat?: never
      • OptionalregexPattern?: never
    • {
          customMask: string;
          dynamicMask?: never;
          maskFormat?: never;
          regexPattern?: never;
      }
      • customMask: string

        Fixed replacement string.

      • OptionaldynamicMask?: never
      • OptionalmaskFormat?: never
      • OptionalregexPattern?: never
    • {
          customMask?: never;
          dynamicMask?: never;
          maskFormat?: never;
          regexPattern?: never;
      }