Getting Started

Documentation:

For a detailed API reference, usage examples, and more, you can check out the official documentation on Data Guardian's npm page or the GitHub repository.

Installation

npm install data-guardian

Basic Usage

                        
    import { maskString, maskData } from 'data-guardian';

    // Masking a string
    const maskedString = maskString("Sensitive Data");
    console.log(maskedString);  // Output: "*************"

    // Masking an object
    const user = { name: "John Doe", password: "mysecretpassword" };
    const maskedUser = maskData(user);
    console.log(maskedUser);  // Output: { name: "John Doe", password: "*************" }

                        
                    

Customization

                        
    const options = {
        maskingChar: '.',
        fixedMaskLength: true,
        maskLength: 5
    };
    const maskedString = maskString("Example log line with my 1AG2ccxL#!.?X$ super secret password", options);
    console.log(maskedString);  // Output: "Example log line with my ..... super secret password"