{"id":22076550,"url":"https://github.com/scokmen/data-mask","last_synced_at":"2025-07-16T13:08:23.345Z","repository":{"id":40432138,"uuid":"57440657","full_name":"scokmen/data-mask","owner":"scokmen","description":"A small string masking library in javascript","archived":false,"fork":false,"pushed_at":"2023-12-15T14:56:22.000Z","size":69,"stargazers_count":12,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-11-10T11:31:03.366Z","etag":null,"topics":["bower","data-mask","javascript","mask","no-dependencies","npm"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/data-mask","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/scokmen.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-04-30T12:20:55.000Z","updated_at":"2024-06-27T15:53:38.000Z","dependencies_parsed_at":"2022-08-18T14:02:25.273Z","dependency_job_id":null,"html_url":"https://github.com/scokmen/data-mask","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scokmen%2Fdata-mask","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scokmen%2Fdata-mask/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scokmen%2Fdata-mask/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scokmen%2Fdata-mask/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/scokmen","download_url":"https://codeload.github.com/scokmen/data-mask/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227441054,"owners_count":17776660,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bower","data-mask","javascript","mask","no-dependencies","npm"],"created_at":"2024-11-30T22:15:08.068Z","updated_at":"2024-11-30T22:15:08.771Z","avatar_url":"https://github.com/scokmen.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# data-mask\nDependency free string masking library\n\n[![GitHub version](https://badge.fury.io/gh/scokmen%2Fdata-mask.svg)](https://badge.fury.io/gh/scokmen%2Fdata-mask)\n[![npm version](https://badge.fury.io/js/data-mask.svg)](http://badge.fury.io/js/data-mask)\n[![Bower version](https://badge.fury.io/bo/data-mask.svg)](http://badge.fury.io/bo/data-mask)\n[![Build Status](https://travis-ci.org/scokmen/data-mask.svg?branch=master)](https://travis-ci.org/scokmen/data-mask)\n[![codecov](https://codecov.io/gh/scokmen/data-mask/branch/master/graph/badge.svg)](https://codecov.io/gh/scokmen/data-mask)\n\n# Installation\n\n**Bower:**\n\n```bash\n$ bower install data-mask\n```\n\n**Npm:**\n\n```bash\n$ npm install data-mask\n```\n\n# Usage\n\n **Use it by using DataMasker instance with plain text:**\n\n```javascript\n/**\n * options parameter is optional in the constructor.\n */\nvar dataMasker = new DataMasker('lorem ipsum', options); //options is optional\nvar output = '';\n\n//options can be override on function call.\noutput = dataMasker.maskLeft(2);   //\"**rem **sum\"\noutput = dataMasker.maskRight(2);  //\"lor** ips**\"\noutput = dataMasker.maskRandom(2); //\"lo*e* ip**m\" etc (random chars)\n\n//options can be override on function call.\noutput = dataMasker.maskLeft(2, ' ', '#');   //\"##rem ##sum\"\noutput = dataMasker.maskRight(2, ' ', '@');  //\"lor@@ ips@@\"\noutput = dataMasker.maskRandom(2, ' ', '-'); //\"lo-e- ip--m\" etc (random chars)\noutput = dataMasker.maskLeft(2, 4, '?');     //\"??re??ip??m\"\" (fixed chunks)\n\n//before \u0026 after mask functions.\noutput = dataMasker.maskLeft(2, ' ', '?', beforeMaskFn, afterMaskFn);\n\n//or just call mask function.\noutput = dataMasker.mask(2, ' ', '#', 1);   //\"##rem ##sum\"\n\n//also static methods are available.\noutput = DataMasker.maskLeft('lorem ipsum', 2, ' ', '#');   //\"##rem ##sum\"\noutput = DataMasker.maskRight('lorem ipsum', 2, ' ', '@');  //\"lor@@ ips@@\"\noutput = DataMasker.maskRandom('lorem ipsum', 2, ' ', '-'); //\"lo-e- ip--m\" etc (random chars)\noutput = DataMasker.maskLeft('lorem ipsum', 2, 4, '?');     //\"??re??ip??m\"\" (fixed chunks)\n```\n\n# Options\n\n**Options for constructor or method params:**\n \nOption       | Description\n--- | ---\n`char`    | An one-length string used for mask. **Default** (`*`)\n`deliminator` | A deliminator string or a number for fixed length tokens. **Default** (`space`)\n`direction  ` | Mask positions. Left, right or mixed positions `1`, `-1`, `0` **Default** (`1`)\n`count`       | Masked character count or percentage for per token (0 \u003c count \u003c 1), count=0 is random character count. **Default**(`0`)\n`beforeMask`  | Callback function on before mask for each token.  fn(`token`, `count`, `char`, `deliminator`, `index`), a string token expected. Return `false` for prevent masking. \n`aftermask`  | Callback function on after mask for each token.  fn(`token`, `count`, `char`, `deliminator`, `index`), a string token expected. Return `false` for exclude token.\n\n# Callbacks\n\n**beforeMask and afterMask examples:**\n\n```javascript\nfunction beforeMask(token, count, char, deliminator, index) {\n    if(token=='lorem'){\n        return 'LOREM'; //Uppercase 'lorem'\n    }\n    else if(token == 'ipsum'){\n        return false; //Not mask 'ipsum'\n    }\n    else{\n        return token;\n    }\n}\n\nfunction afterMask(token, count, char, deliminator, index) {\n    if(token === char){\n        return false; //Ignore if token equals to char\n    }\n    else{\n        return token;\n    }\n}\n```\n# License\n\nCopyright (c) 2016 Soner Çökmen, Licensed under the MIT license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscokmen%2Fdata-mask","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscokmen%2Fdata-mask","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscokmen%2Fdata-mask/lists"}