Giter Club home page Giter Club logo

censor-json's Introduction

censor-json

JSON redacting library for nodejs

Install

npm install --save censor-json

Usage

Its usage is quite simple. You will need two things

  • A json object which you want to redact/censor
  • A mapping object, i.e, array of paths which will be redacted.
const censorData = require('censor-json');
censorData.redact(mapping, data);

Demo

const censorData = require('censor-json');
const data = {
    name: 'Ned Stark',
    house: 'Stark'
    details: {
        reason_of_death: 'honor',
        killed_by: 'Illyn payne, Joffery, Baelish'
    },
    motto: 'Winter is Coming!'
}

const mapping = {
    { path: 'name' },
    { path: 'motto' },
    { path: 'details.reason_of_death' }
}

censorData.redact(mapping, data); 

/*
Output: {
    name: 'N*d *ta**',
    house: 'Stark'
    details: {
        reason_of_death: '*on**',
        killed_by: 'Illyn payne, Joffery, Baelish'
    },
    motto: '*i**er i* C*m**g!'
}
*/

Future

In future version I will be adding more features like

  • zipping of files
  • uploading to S3

If more features you want to be in this package, please let me know by creating a request here.

Also use this link to let me know of any bugs or issues.

censor-json's People

Contributors

myke11j avatar nodexpertsdev avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.