{"id":15516598,"url":"https://github.com/git-ced/redact","last_synced_at":"2025-04-23T03:32:30.618Z","repository":{"id":42781520,"uuid":"274918766","full_name":"git-ced/redact","owner":"git-ced","description":"Censors blacklisted words with built in lists of words that can be used.","archived":false,"fork":false,"pushed_at":"2023-01-07T19:28:56.000Z","size":1652,"stargazers_count":6,"open_issues_count":14,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-29T21:41:24.152Z","etag":null,"topics":["censor","filter","hacktoberfest","profanity-detection","profanity-filter","redact"],"latest_commit_sha":null,"homepage":"https://git-ced.github.io/redact-docs/","language":"TypeScript","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/git-ced.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2020-06-25T13:07:40.000Z","updated_at":"2023-03-09T02:23:43.000Z","dependencies_parsed_at":"2023-02-07T22:45:38.300Z","dependency_job_id":null,"html_url":"https://github.com/git-ced/redact","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/git-ced%2Fredact","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/git-ced%2Fredact/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/git-ced%2Fredact/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/git-ced%2Fredact/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/git-ced","download_url":"https://codeload.github.com/git-ced/redact/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249866049,"owners_count":21336989,"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":["censor","filter","hacktoberfest","profanity-detection","profanity-filter","redact"],"created_at":"2024-10-02T10:08:48.549Z","updated_at":"2025-04-23T03:32:30.592Z","avatar_url":"https://github.com/git-ced.png","language":"TypeScript","readme":"# redact\n\u003e Censors blacklisted words with built in lists of words that can be used.\n\n[![NPM](https://img.shields.io/npm/v/@princedev/redact.svg)](https://www.npmjs.com/package/@princedev/redact)\n![npm bundle size (scoped)](https://img.shields.io/bundlephobia/min/@princedev/redact)\n![npm bundle size (scoped version)](https://img.shields.io/bundlephobia/minzip/@princedev/redact)\n![Libraries.io dependency status for latest release, scoped npm package](https://img.shields.io/librariesio/release/npm/@princedev/redact)\n![NPM](https://img.shields.io/npm/l/@princedev/redact)\n\n## Table of Contents\n - [Installation](#installation)\n - [Import](#import)\n - [Usage](#usage)\n - [Authors](#authors)\n - [Changelog](#changelog)\n - [License](#license)\n\n \u003c!-- toc --\u003e\n\n## Installation\n\nThis library is available through the [npm registry](https://www.npmjs.com/).\n\nNPM\n```bash\n$ npm -i @princedev/redact\n```\n\nYarn\n```bash\n$ yarn add @princedev/redact\n```\n\n## Import\n\nStart using it by importing the library first.\n\n### CommonJS\n```javascript\nconst redact = require('@princedev/redact');\n```\n\n### ES6\n```javascript\nimport { redact } from '@princedev/redact';\n```\n\n## Usage\n\n**Redact or censor a word from a sentence**\n```javascript\nimport { redact } from '@princedev/redact';\n\nconst englishProfanity = ['fuck', 'shit', ...];\n\nredact('Fuck yeah', englishProfanity,);\n// output: **** yeah\n\nredact('Fuck yeah', englishProfanity, {\n  grawlix: '$',\n  replaceByLength: false,\n});\n// output: $ yeah\n```\n\n**Can also be done in this way.**\n```javascript\nimport redact from '@princedev/redact';\n\nconst englishProfanity = ['fuck', 'shit', ...];\n\nredact.redact('Fuck yeah', englishProfanity);\n// output: **** yeah\n\nredact.redact('Fuck yeah', englishProfanity, {\n  grawlix: '$',\n  replaceByLength: false,\n});\n// output: $ yeah\n```\n\nRead the [docs](https://git-ced.github.io/redact-docs/) for more.\n\n## Authors\n\n- [Prince Neil Cedrick Castro](https://github.com/git-ced/) - Initial work\n\nSee also the list of [contributors](https://github.com/git-ced/redact/contributors) who participated in this project.\n\n## Changelog\n\n[Changelog](https://github.com/git-ced/redact/releases)\n\n## License\n\n  [MIT](LICENSE)","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgit-ced%2Fredact","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgit-ced%2Fredact","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgit-ced%2Fredact/lists"}