{"_id":"@codexcentral/mask-text-to-symbol","_rev":"1-20a9dfacda10a1c7a52817ffbcedeef2","name":"@codexcentral/mask-text-to-symbol","dist-tags":{"latest":"1.1.0"},"versions":{"1.0.0":{"name":"@codexcentral/mask-text-to-symbol","version":"1.0.0","description":"Takes a string as input and returns a new string with all characters replaced by an specified symbol.","license":"Apache-2.0","main":"./dist/cjs/index.js","module":"./dist/esm/index.js","types":"./dist/esm/index.d.ts","keywords":["typescript"],"author":{"name":"Roberto Silva Zuñiga","email":"c.roberto.u@gmail.com"},"repository":{"type":"git","url":"git+https://github.com/Codex-Central/mask-text-to-symbol.git"},"bugs":{"url":"https://github.com/Codex-Central/mask-text-to-symbol/issues"},"homepage":"https://github.com/Codex-Central/mask-text-to-symbol#readme","scripts":{"build":"rm -rf dist/ && yarn build:esm && yarn build:cjs","build:esm":"tsc --outDir dist/esm --module esnext","build:cjs":"tsc --outDir dist/cjs --module commonjs"},"devEngines":{"node":">=18.x","npm":">=9.x"},"devDependencies":{"@types/node":"^18.11.9","@typescript-eslint/eslint-plugin":"^6.15.0","@typescript-eslint/parser":"^6.15.0","eslint":"^8.56.0","typescript":"^5.3.3"},"gitHead":"8b928f0084f6e0ed749258b70e1ca4204e452405","_id":"@codexcentral/mask-text-to-symbol@1.0.0","_nodeVersion":"18.16.1","_npmVersion":"9.5.1","dist":{"integrity":"sha512-HWqliT0kHJcRrLrBx3rK2TINejCj9b2LGXiEy8SWZGEuo3glOpznPJHXGl4olkvPFhj/upscpsBltEddDmb/Ng==","shasum":"3fc0e1e8eb8eba8799553fa5f2263e1568ec1ea0","tarball":"https://registry.npmjs.org/@codexcentral/mask-text-to-symbol/-/mask-text-to-symbol-1.0.0.tgz","fileCount":15,"unpackedSize":17931,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGuthB6tCE4bU5uhkBNVIBEWfmYFnFdfdGnM+p6Hz6FkAiEAyZmrmMNrMPNLGTLA6Lr5BJhWPPJqp5+M6uPP7vrwSsk="}]},"_npmUser":{"name":"roberto.silva","email":"c.roberto.u@gmail.com"},"directories":{},"maintainers":[{"name":"roberto.silva","email":"c.roberto.u@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mask-text-to-symbol_1.0.0_1703199951997_0.8529869217651458"},"_hasShrinkwrap":false},"1.1.0":{"name":"@codexcentral/mask-text-to-symbol","version":"1.1.0","description":"Takes a string as input and returns a new string with all characters replaced by an specified symbol.","license":"Apache-2.0","main":"./dist/cjs/index.js","module":"./dist/esm/index.js","types":"./dist/esm/index.d.ts","keywords":["typescript","string","replace","text","mask","password","javascript","node"],"author":{"name":"Roberto Silva Zuñiga","email":"c.roberto.u@gmail.com"},"repository":{"type":"git","url":"git+https://github.com/Codex-Central/mask-text-to-symbol.git"},"bugs":{"url":"https://github.com/Codex-Central/mask-text-to-symbol/issues"},"homepage":"https://github.com/Codex-Central/mask-text-to-symbol#readme","scripts":{"build":"rm -rf dist/ && yarn build:esm && yarn build:cjs","build:esm":"tsc --outDir dist/esm --module esnext","build:cjs":"tsc --outDir dist/cjs --module commonjs"},"devEngines":{"node":">=18.x","npm":">=9.x"},"devDependencies":{"@types/node":"^18.11.9","@typescript-eslint/eslint-plugin":"^6.15.0","@typescript-eslint/parser":"^6.15.0","eslint":"^8.56.0","typescript":"^5.3.3"},"gitHead":"21faa3ae554e721125960274409b3a8200583af0","_id":"@codexcentral/mask-text-to-symbol@1.1.0","_nodeVersion":"18.16.1","_npmVersion":"9.5.1","dist":{"integrity":"sha512-7wv5lSCRjgfXQwRchpoVtI07jI+vBmEEuBkadF74nAC1xw2wAzUpENqqGJXPINhSD9Zn8CNSIRFFzaKcjn3KNg==","shasum":"f1277cb1a36743203a6f76cbf80095dcacd87819","tarball":"https://registry.npmjs.org/@codexcentral/mask-text-to-symbol/-/mask-text-to-symbol-1.1.0.tgz","fileCount":15,"unpackedSize":18047,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDUvxs3oYQUJBqMpqfCNK48JYuqdyAftIV98G0NlN6zFgIgCP3/zU5mHg6KQQ4N4jjJ6ZLrl0FyXIkxYWncwwvpj08="}]},"_npmUser":{"name":"roberto.silva","email":"c.roberto.u@gmail.com"},"directories":{},"maintainers":[{"name":"roberto.silva","email":"c.roberto.u@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mask-text-to-symbol_1.1.0_1703201267993_0.7144996728117932"},"_hasShrinkwrap":false}},"time":{"created":"2023-12-21T23:05:51.904Z","1.0.0":"2023-12-21T23:05:52.218Z","modified":"2023-12-21T23:27:48.411Z","1.1.0":"2023-12-21T23:27:48.195Z"},"maintainers":[{"name":"roberto.silva","email":"c.roberto.u@gmail.com"}],"description":"Takes a string as input and returns a new string with all characters replaced by an specified symbol.","homepage":"https://github.com/Codex-Central/mask-text-to-symbol#readme","keywords":["typescript","string","replace","text","mask","password","javascript","node"],"repository":{"type":"git","url":"git+https://github.com/Codex-Central/mask-text-to-symbol.git"},"author":{"name":"Roberto Silva Zuñiga","email":"c.roberto.u@gmail.com"},"bugs":{"url":"https://github.com/Codex-Central/mask-text-to-symbol/issues"},"license":"Apache-2.0","readme":"# mask-text-to-symbol\r\n\r\nTakes a string as input and returns a new string with all characters replaced by an specified symbol.\r\n\r\n## Installation\r\n\r\n> `npm install @codexcentral/mask-text-to-symbol`\r\n\r\n## Usage\r\n\r\n### 1. Importing...\r\n\r\n```javascript\r\nimport { maskTextToSymbol } from \"@codexcentral/mask-text-to-symbol\";\r\n```\r\n\r\n### 2. Call the functions\r\n\r\n#### Example with default symbol\r\n\r\n```javascript\r\n  const text = \"password\";\r\n  const password = maskTextToSymbol({ text });\r\n  console.log(password);\r\n  // { original: 'password', masked: '********' }\r\n```\r\n\r\n#### Example with symbol\r\n\r\n```javascript\r\n  const text = 'password';\r\n  const password = maskTextToSymbol({ text, symbol: 'a' });\r\n  console.log(password);\r\n  // { original: 'password', masked: 'aaaaaaaa'}\r\n```\r\n\r\n### Attributes\r\n\r\n| Attribute  | Type     | Mandatory                               |\r\n| ---------- | -------- | --------------------------------------- |\r\n| text | `string` | true                                    |\r\n| symbol | `number` | false (default: `*`)                       |\r\n\r\n\r\n\r\n## Wrapper function as a Helper (optional)\r\n### 1. Import the function\r\n\r\n```javascript\r\nimport { maskTextToSymbol, TMaskTextToSymbol } from \"@codexcentral/mask-text-to-symbol\";\r\n```\r\n\r\n### 2. Create the Helper function\r\n\r\n```javascript\r\nconst maskTextToSymbolHelper = ({ text, symbol }: TMaskTextToSymbol) => {\r\n  return maskTextToSymbol({ text, symbol });\r\n};\r\n```\r\n\r\n\r\n\r\n# Credits\r\n\r\nThese code was written by [Roberto Silva Z.](https://www.linkedin.com/in/robertosilvazuniga/)\r\n","readmeFilename":"README.md"}