{"id":18396731,"url":"https://github.com/igorskyflyer/npm-mapped-replacer","last_synced_at":"2025-04-07T04:32:45.323Z","repository":{"id":56137392,"uuid":"213448442","full_name":"igorskyflyer/npm-mapped-replacer","owner":"igorskyflyer","description":"🗺 Zero-dependency Map and RegExp based string replacer with Unicode support. 🍁","archived":false,"fork":false,"pushed_at":"2024-07-28T15:22:59.000Z","size":556,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-22T13:23:16.656Z","etag":null,"topics":["back-end","biome","decoder","encoder","expression","igorskyflyer","javascript","js","map","module","node","npm","package","regexp","replacer","string","typescript","vitest"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@igor.dvlpr/mapped-replacer","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/igorskyflyer.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"ko_fi":"igorskyflyer"}},"created_at":"2019-10-07T17:43:58.000Z","updated_at":"2024-07-28T15:23:02.000Z","dependencies_parsed_at":"2024-07-27T18:03:07.812Z","dependency_job_id":null,"html_url":"https://github.com/igorskyflyer/npm-mapped-replacer","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/igorskyflyer%2Fnpm-mapped-replacer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/igorskyflyer%2Fnpm-mapped-replacer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/igorskyflyer%2Fnpm-mapped-replacer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/igorskyflyer%2Fnpm-mapped-replacer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/igorskyflyer","download_url":"https://codeload.github.com/igorskyflyer/npm-mapped-replacer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247595082,"owners_count":20963939,"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":["back-end","biome","decoder","encoder","expression","igorskyflyer","javascript","js","map","module","node","npm","package","regexp","replacer","string","typescript","vitest"],"created_at":"2024-11-06T02:14:41.141Z","updated_at":"2025-04-07T04:32:45.059Z","avatar_url":"https://github.com/igorskyflyer.png","language":"TypeScript","funding_links":["https://ko-fi.com/igorskyflyer"],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e🗺 Mapped Replacer 🍁\u003c/h1\u003e\n\n\u003cbr\u003e\n\n\u003cdiv align=\"center\"\u003e\n  🗺 Zero-dependency Map and RegExp based string replacer with Unicode support. 🍁\n\u003c/div\u003e\n\n\u003cbr\u003e\n\u003cbr\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003cblockquote\u003e\n    \u003cbr\u003e\n    \u003ch4\u003e💖 Support further development\u003c/h4\u003e\n    \u003cspan\u003eI work hard for every project, including this one\n    \u003cbr\u003e\n    and your support means a lot to me!\n    \u003cbr\u003e\n    \u003cbr\u003e\n    Consider buying me a coffee. ☕\n    \u003cbr\u003e\n    \u003cstrong\u003eThank you for supporting my efforts! 🙏😊\u003c/strong\u003e\u003c/span\u003e\n    \u003cbr\u003e\n    \u003cbr\u003e\n    \u003ca href=\"https://ko-fi.com/igorskyflyer\" target=\"_blank\"\u003e\u003cimg src=\"https://raw.githubusercontent.com/igorskyflyer/igorskyflyer/main/assets/ko-fi.png\" alt=\"Donate to igorskyflyer\" width=\"150\"\u003e\u003c/a\u003e\n    \u003cbr\u003e\n    \u003cbr\u003e\n    \u003ca href=\"https://github.com/igorskyflyer\"\u003e\u003cem\u003e@igorskyflyer\u003c/em\u003e\u003c/a\u003e\n    \u003cbr\u003e\n    \u003cbr\u003e\n    \u003cbr\u003e\n  \u003c/blockquote\u003e\n\u003c/div\u003e\n\n\u003cbr\u003e\n\u003cbr\u003e\n\n## 📃 Table of contents\n\n- [Usage](#-usage)\n- [API](#-api)\n    - [constructor()](#constructoroptions-ioptions-mappedreplacer)\n    - [addRule(replaceWith: string, searchFor: string)](#addrulereplacewith-string-searchfor-string-boolean)\n    - [addRule(replaceWith: string, searchFor: string[])](#addrulereplacewith-string-searchfor-string-boolean-1)\n    - [addRules(rules: { [key: string]: string })](#addrulesrules--key-string-string--boolean)\n    - [addRules(rules: { [key: string]: string[] })](#addrulesrules--key-string-string--boolean-1)\n    - [hasRule(rules: string)](#hasrulerule-string-boolean)\n    - [removeRule()](#removerulesearchfor-string-boolean)\n    - [rulesCount()](#rulescount-number)\n    - [clearRules()](#clearrules-void)\n    - [replace()](#replaceinput-string-string)\n- [Examples](#-examples)\n- [Changelog](#-changelog)\n- [License](#-license)\n- [Related](#-related)\n- [Author](#-author)\n\n\u003cbr\u003e\n\u003cbr\u003e\n\n## 🕵🏼 Usage\n\nInstall it by executing:\n\n```shell\nnpm i \"@igor.dvlpr/mapped-replacer\"\n```\n\n\u003cbr\u003e\n\n## 🤹🏼 API\n\n### `constructor(options?: IOptions): MappedReplacer`\n\n*Creates a new instance of `MappedReplacer`.*  \n\n\u003cbr\u003e\n\n`options` is a variable of type `IOptions` defined as:\n\n- `caseSensitive` - A Boolean that indicates whether replacing should be case-sensitive or not. Default is `true`.  \n\n- `strict` - A Boolean that indicates whether strict mode is enabled. In strict mode, only whole matches are replaced. Default is `false`.\n\n---\n\n### `addRule(replaceWith: string, searchFor: string): boolean`\n\n*Adds a new rule or updates an existing rule used in replacing a single string.*  \n\n`replaceWith` - The string to replace the `searchFor` with.  \n\n`searchFor` - The string to be replaced.  \n\nReturns true if the rule was added or updated successfully, false otherwise.\n\n\u003cbr\u003e\n\n```ts\nimport { MappedReplacer } from '@igor.dvlpr/mapped-replacer'\n\nconst mapper: MappedReplacer = new MappedReplacer()\n\nmapper.addRule('😀', ':smile:')\n\nconsole.log(mapper.replace('Hello world :smile:')) // outputs 'Hello world 😀'\n```\n\n\u003cbr\u003e\n\n### `addRule(replaceWith: string, searchFor: string[]): boolean`\n\n*Adds a new rule or updates an existing rule for character replacement with multiple subjects.*  \n\n`replaceWith` - The string to replace the `searchFor` with.  \n\n`searchFor` - The array of strings to be replaced.\n\nReturns true if the rule was added or updated successfully, false otherwise.\n\n\u003cbr\u003e\n\n```ts\nimport { MappedReplacer } from '@igor.dvlpr/mapped-replacer'\n\nconst mapper: MappedReplacer = new MappedReplacer()\n\nmapper.addRule('😀', [':smile:', ':D'])\n\nconsole.log(mapper.replace('Hello world :smile: :D')) // outputs 'Hello world 😀 😀'\n```\n\n---\n\n### `addRules(rules: { [key: string]: string }): boolean`\n\n*Adds or updates the rules for string replacement.*  \n\n`rules` - A simple key-value object, i.e.:  \n\n\u003cbr\u003e\n\n```ts\n{\n  '\u0026#60;' : '\u003c',\n  '\u0026#62;' : '\u003e'\n}\n```  \n\nReturns a Boolean whether the rules were added/updated successfully.\n\n\u003cbr\u003e\n\n```ts\nimport { MappedReplacer } from '@igor.dvlpr/mapped-replacer'\n\nconst mapper: MappedReplacer = new MappedReplacer()\n\nmapper.addRules({\n  '\u0026#120139;' : '𝕋',\n  '\u0026#8776;' : '≈',\n  '\u0026#120113;' : '𝔱'\n})\n\nconsole.log(mapper.replace('𝕋 ≈ 𝔱')) // outputs '\u0026#120139; \u0026#8776; \u0026#120113;'\n```\n\n\u003cbr\u003e\n\n\n### `addRules(rules: { [key: string]: string[] }): boolean`\n\n*Adds or updates the rules for string replacement.*  \n\n`rules` - A simple key-value[] object, i.e.:  \n\n\u003cbr\u003e\n\n```ts\n{\n  '😁' : [':D', ':-D'],\n  '😛' : [':P', ':-P']\n}\n```  \n\nReturns a Boolean whether the rules were added/updated successfully.\n\n\u003cbr\u003e\n\n```ts\nimport { MappedReplacer } from '@igor.dvlpr/mapped-replacer'\n\nconst mapper: MappedReplacer = new MappedReplacer()\n\nmapper.addRules({\n  '😁' : [':D', ':-D'],\n  '😛' : [':P', ':-P']\n})\n\nconsole.log(mapper.replace('Hello :D world :-D this is a :P test :-P')) // outputs 'Hello 😁 world 😁 this is a 😛 test 😛'\n```\n\n---\n\n### `hasRule(rule: string): boolean`\n\n*Checks whether a rule is present in the Map.*  \n\n`rule` - The rule to check for.  \n\nReturns a Boolean indicating the existence of the given rule.\n\n\u003cbr\u003e\n\n```ts\nimport { MappedReplacer } from '@igor.dvlpr/mapped-replacer'\n\nconst mapper: MappedReplacer = new MappedReplacer()\n\nmapper.addRule('\u0026#120139;', '𝕋')\nmapper.addRule('\u0026#8776;', '≈')\n\nconsole.log(mapper.hasRule('𝕋')) // true\n```\n\n---\n\n### `removeRule(searchFor: string): boolean`\n\n*Removes the rule that matches the provided value.*  \n\n`searchFor` - The rule to remove.\n\n\u003cbr\u003e\n\n```ts\nimport { MappedReplacer } from '@igor.dvlpr/mapped-replacer'\n\nconst mapper: MappedReplacer = new MappedReplacer()\n\nmapper.addRule('\u0026#120139;', '𝕋')\nmapper.addRule('\u0026#8776;', '≈')\n\nmapper.removeRule('𝕋')\n\nconsole.log(mapper.replace('𝕋 ≈ 𝔱')) // outputs '𝕋 \u0026#8776; 𝔱'\n```\n\n\u003cbr\u003e\n\n### `rulesCount(): number`\n\n*Gets the number of rules for string replacing.*\n\n\u003cbr\u003e\n\n```ts\nimport { MappedReplacer } from '@igor.dvlpr/mapped-replacer'\n\nconst mapper: MappedReplacer = new MappedReplacer()\n\nmapper.addRule('\u0026#120139;', '𝕋')\n\nconsole.log(mapper.rulesCount()) // outputs 1\n```\n\n\u003cbr\u003e\n\n### `clearRules(): void`\n\n*Clears all the rules.*  \n\n\u003cbr\u003e\n\n```ts\nimport { MappedReplacer } from '@igor.dvlpr/mapped-replacer'\n\nconst mapper: MappedReplacer = new MappedReplacer()\n\nmapper.addRule('\u0026#120139;', '𝕋')\nmapper.clearRules()\n\nconsole.log(mapper.rulesCount()) // outputs 0\n```\n\n\u003cbr\u003e\n\n### `replace(input: string): string`\n\n*Replaces the values in the input with the values from the Map.*  \n\n`input` - The input string.\n\n\u003cbr\u003e\n\n```ts\nimport { MappedReplacer } from '@igor.dvlpr/mapped-replacer'\n\nconst mapper: MappedReplacer = new MappedReplacer()\n\nmapper.addRule('\u0026#8594;', '→')\n\nconsole.log(mapper.replace('a → b')) // outputs 'a \u0026#8594; b'\n```\n\n---\n\n## ✨ Examples\n\n`example.ts`\n```ts\nimport { MappedReplacer } from '@igor.dvlpr/mapped-replacer'\n\nconst mapper: MappedReplacer = new MappedReplacer()\n\nmapper.addRule('\u0026#8594;', '→')\n\nconsole.log(mapper.replace('a → b')) // outputs 'a \u0026#8594; b'\n```\n\n---\n\n## 📝 Changelog\n\n📑 The changelog is available here: [CHANGELOG.md](https://github.com/igorskyflyer/npm-mapped-replacer/blob/main/CHANGELOG.md).\n\n---\n\n## 🪪 License\n\nLicensed under the MIT license which is available here, [MIT license](https://github.com/igorskyflyer/npm-mapped-replacer/blob/main/LICENSE).\n\n---\n\n## 🧬 Related\n\n[@igor.dvlpr/str-is-in](https://www.npmjs.com/package/@igor.dvlpr/str-is-in)\n\n\u003e _🧵 Provides ways of checking whether a String is present in an Array of Strings using custom Comparators. 🔍_\n\n\u003cbr\u003e\n\n[@igor.dvlpr/duoscribi](https://www.npmjs.com/package/@igor.dvlpr/duoscribi)\n\n\u003e _✒ DúöScríbî allows you to convert letters with diacritics to regular letters. 🤓_\n\n\u003cbr\u003e\n\n[@igor.dvlpr/strip-yaml-front-matter](https://www.npmjs.com/package/@igor.dvlpr/strip-yaml-front-matter)\n\n\u003e _🦓 Strips YAML front matter from a String or a file. 👾_\n\n\u003cbr\u003e\n\n[@igor.dvlpr/encode-entities](https://www.npmjs.com/package/@igor.dvlpr/encode-entities)\n\n\u003e _🏃‍♂️ Fast and simple Map and RegExp based HTML entities encoder. 🍁_\n\n\u003cbr\u003e\n\n[@igor.dvlpr/strip-html](https://www.npmjs.com/package/@igor.dvlpr/strip-html)\n\n\u003e _🥞 Removes HTML code from the given string. Can even extract text-only from the given an HTML string. ✨_\n\n---\n\n\u003cbr\u003e\n\n### 👨🏻‍💻 Author\nCreated by **Igor Dimitrijević** ([*@igorskyflyer*](https://github.com/igorskyflyer/)).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Figorskyflyer%2Fnpm-mapped-replacer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Figorskyflyer%2Fnpm-mapped-replacer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Figorskyflyer%2Fnpm-mapped-replacer/lists"}