{"id":15383329,"url":"https://github.com/andreruffert/maskify","last_synced_at":"2025-02-28T09:31:36.973Z","repository":{"id":38451966,"uuid":"184240757","full_name":"andreruffert/maskify","owner":"andreruffert","description":"🐼 Mask sensitive data strings","archived":false,"fork":false,"pushed_at":"2023-01-16T14:01:19.000Z","size":120,"stargazers_count":3,"open_issues_count":8,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-10-05T11:01:23.037Z","etag":null,"topics":["javascript","mask","nodejs","utility"],"latest_commit_sha":null,"homepage":"https://npm.im/maskify","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/andreruffert.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-04-30T10:17:30.000Z","updated_at":"2022-02-17T15:56:03.000Z","dependencies_parsed_at":"2023-02-04T08:31:52.207Z","dependency_job_id":null,"html_url":"https://github.com/andreruffert/maskify","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andreruffert%2Fmaskify","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andreruffert%2Fmaskify/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andreruffert%2Fmaskify/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andreruffert%2Fmaskify/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/andreruffert","download_url":"https://codeload.github.com/andreruffert/maskify/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219880182,"owners_count":16562704,"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":["javascript","mask","nodejs","utility"],"created_at":"2024-10-01T14:36:57.320Z","updated_at":"2024-10-16T20:02:24.891Z","avatar_url":"https://github.com/andreruffert.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# maskify\n\n\u003e Mask sensitive data strings and only expose certain parts\n\n[![CI status](https://github.com/andreruffert/maskify/workflows/CI/badge.svg)](https://github.com/andreruffert/maskify/actions?workflow=CI)\n[![npm version](https://img.shields.io/npm/v/maskify.svg)](https://www.npmjs.com/package/maskify)\n[![npm downloads](https://img.shields.io/npm/dm/maskify?logo=npm)](https://www.npmjs.com/package/maskify)\n\nUseful to mask credit card numbers, secret tokens or any other data.\n\n## Install\n\n```\n$ npm install maskify\n```\n\n\n## Usage\n\n\n```js\nimport maskify from 'maskify';\n\n// Example to mask a standard credit card number\nmaskify('4556-3646-0793-5616');\n// =\u003e '4###-####-####-5616'\n\n// By default only masks digits\nmaskify('A1234567BCDEFG89HI');\n// =\u003e 'A#######BCDEFG89HI'\n\n// By default does not mask short credit card numbers\nmaskify('54321');\n// =\u003e '54321'\n\n```\n\n\n## API\n\n### maskify(string, [options])\n\nReturns a new masked string.\n\n#### string\nType: `string`\n\n#### options\nType: `object`\n\n##### maskSymbol\nType: `string`           \nDefault: `#`\n\nSymbol to mask the characters with.\n\n##### matchPattern\nType: `regexObj`           \nDefault: `/^\\d+$/`\n\nOnly mask characters matching the pattern and keep other characters unmasked.\n\n##### visibleCharsStart\nType: `number`           \nDefault: `1`\n\nNumber of characters not to mask at the __start__ of the string (__`4`__ `###-####-####`)\n\n##### visibleCharsEnd\nType: `number`           \nDefault: `4`\n\nNumber of characters not to mask at the __end__ of the string (`###-####-####` __`5616`__).\n\n##### minChars\nType: `number`           \nDefault: `6`\n\nMinimum characters of input string length to start masking.\n\n\n## License\n\nMIT © [André Ruffert](https://andreruffert.com)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandreruffert%2Fmaskify","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fandreruffert%2Fmaskify","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandreruffert%2Fmaskify/lists"}