https://github.com/igorskyflyer/npm-mapped-replacer

🗺 Zero-dependency Map and RegExp based string replacer with Unicode support. 🍁
https://github.com/igorskyflyer/npm-mapped-replacer

back-end biome decoder encoder expression igorskyflyer javascript js map module node npm package regexp replacer string typescript vitest

Last synced: 20 days ago
JSON representation

🗺 Zero-dependency Map and RegExp based string replacer with Unicode support. 🍁

Host: GitHub
URL: https://github.com/igorskyflyer/npm-mapped-replacer
Owner: igorskyflyer
License: mit
Created: 2019-10-07T17:43:58.000Z (over 5 years ago)
Default Branch: main
Last Pushed: 2024-07-28T15:22:59.000Z (9 months ago)
Last Synced: 2025-03-22T13:23:16.656Z (about 1 month ago)
Topics: back-end, biome, decoder, encoder, expression, igorskyflyer, javascript, js, map, module, node, npm, package, regexp, replacer, string, typescript, vitest
Language: TypeScript
Homepage: https://www.npmjs.com/package/@igor.dvlpr/mapped-replacer
Size: 543 KB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

        
🗺 Mapped Replacer 🍁







  🗺 Zero-dependency Map and RegExp based string replacer with Unicode support. 🍁











  

    


    💖 Support further development

    I work hard for every project, including this one

    


    and your support means a lot to me!

    


    


    Consider buying me a coffee. ☕

    


    Thank you for supporting my efforts! 🙏😊

    


    


    

    


    


    @igorskyflyer

    


    


    


  









## 📃 Table of contents

- [Usage](#-usage)

- [API](#-api)

    - [constructor()](#constructoroptions-ioptions-mappedreplacer)

    - [addRule(replaceWith: string, searchFor: string)](#addrulereplacewith-string-searchfor-string-boolean)

    - [addRule(replaceWith: string, searchFor: string[])](#addrulereplacewith-string-searchfor-string-boolean-1)

    - [addRules(rules: { [key: string]: string })](#addrulesrules--key-string-string--boolean)

    - [addRules(rules: { [key: string]: string[] })](#addrulesrules--key-string-string--boolean-1)

    - [hasRule(rules: string)](#hasrulerule-string-boolean)

    - [removeRule()](#removerulesearchfor-string-boolean)

    - [rulesCount()](#rulescount-number)

    - [clearRules()](#clearrules-void)

    - [replace()](#replaceinput-string-string)

- [Examples](#-examples)

- [Changelog](#-changelog)

- [License](#-license)

- [Related](#-related)

- [Author](#-author)







## 🕵🏼 Usage

Install it by executing:

```shell

npm i "@igor.dvlpr/mapped-replacer"

```




## 🤹🏼 API

### `constructor(options?: IOptions): MappedReplacer`

*Creates a new instance of `MappedReplacer`.*  




`options` is a variable of type `IOptions` defined as:

- `caseSensitive` - A Boolean that indicates whether replacing should be case-sensitive or not. Default is `true`.  

- `strict` - A Boolean that indicates whether strict mode is enabled. In strict mode, only whole matches are replaced. Default is `false`.

---

### `addRule(replaceWith: string, searchFor: string): boolean`

*Adds a new rule or updates an existing rule used in replacing a single string.*  

`replaceWith` - The string to replace the `searchFor` with.  

`searchFor` - The string to be replaced.  

Returns true if the rule was added or updated successfully, false otherwise.




```ts

import { MappedReplacer } from '@igor.dvlpr/mapped-replacer'

const mapper: MappedReplacer = new MappedReplacer()

mapper.addRule('😀', ':smile:')

console.log(mapper.replace('Hello world :smile:')) // outputs 'Hello world 😀'

```




### `addRule(replaceWith: string, searchFor: string[]): boolean`

*Adds a new rule or updates an existing rule for character replacement with multiple subjects.*  

`replaceWith` - The string to replace the `searchFor` with.  

`searchFor` - The array of strings to be replaced.

Returns true if the rule was added or updated successfully, false otherwise.




```ts

import { MappedReplacer } from '@igor.dvlpr/mapped-replacer'

const mapper: MappedReplacer = new MappedReplacer()

mapper.addRule('😀', [':smile:', ':D'])

console.log(mapper.replace('Hello world :smile: :D')) // outputs 'Hello world 😀 😀'

```

---

### `addRules(rules: { [key: string]: string }): boolean`

*Adds or updates the rules for string replacement.*  

`rules` - A simple key-value object, i.e.:  




```ts

{

  '<' : '<',

  '>' : '>'

}

```  

Returns a Boolean whether the rules were added/updated successfully.




```ts

import { MappedReplacer } from '@igor.dvlpr/mapped-replacer'

const mapper: MappedReplacer = new MappedReplacer()

mapper.addRules({

  '𝕋' : '𝕋',

  '≈' : '≈',

  '𝔱' : '𝔱'

})

console.log(mapper.replace('𝕋 ≈ 𝔱')) // outputs '𝕋 ≈ 𝔱'

```




### `addRules(rules: { [key: string]: string[] }): boolean`

*Adds or updates the rules for string replacement.*  

`rules` - A simple key-value[] object, i.e.:  




```ts

{

  '😁' : [':D', ':-D'],

  '😛' : [':P', ':-P']

}

```  

Returns a Boolean whether the rules were added/updated successfully.




```ts

import { MappedReplacer } from '@igor.dvlpr/mapped-replacer'

const mapper: MappedReplacer = new MappedReplacer()

mapper.addRules({

  '😁' : [':D', ':-D'],

  '😛' : [':P', ':-P']

})

console.log(mapper.replace('Hello :D world :-D this is a :P test :-P')) // outputs 'Hello 😁 world 😁 this is a 😛 test 😛'

```

---

### `hasRule(rule: string): boolean`

*Checks whether a rule is present in the Map.*  

`rule` - The rule to check for.  

Returns a Boolean indicating the existence of the given rule.




```ts

import { MappedReplacer } from '@igor.dvlpr/mapped-replacer'

const mapper: MappedReplacer = new MappedReplacer()

mapper.addRule('𝕋', '𝕋')

mapper.addRule('≈', '≈')

console.log(mapper.hasRule('𝕋')) // true

```

---

### `removeRule(searchFor: string): boolean`

*Removes the rule that matches the provided value.*  

`searchFor` - The rule to remove.




```ts

import { MappedReplacer } from '@igor.dvlpr/mapped-replacer'

const mapper: MappedReplacer = new MappedReplacer()

mapper.addRule('𝕋', '𝕋')

mapper.addRule('≈', '≈')

mapper.removeRule('𝕋')

console.log(mapper.replace('𝕋 ≈ 𝔱')) // outputs '𝕋 ≈ 𝔱'

```




### `rulesCount(): number`

*Gets the number of rules for string replacing.*




```ts

import { MappedReplacer } from '@igor.dvlpr/mapped-replacer'

const mapper: MappedReplacer = new MappedReplacer()

mapper.addRule('𝕋', '𝕋')

console.log(mapper.rulesCount()) // outputs 1

```




### `clearRules(): void`

*Clears all the rules.*  




```ts

import { MappedReplacer } from '@igor.dvlpr/mapped-replacer'

const mapper: MappedReplacer = new MappedReplacer()

mapper.addRule('𝕋', '𝕋')

mapper.clearRules()

console.log(mapper.rulesCount()) // outputs 0

```




### `replace(input: string): string`

*Replaces the values in the input with the values from the Map.*  

`input` - The input string.




```ts

import { MappedReplacer } from '@igor.dvlpr/mapped-replacer'

const mapper: MappedReplacer = new MappedReplacer()

mapper.addRule('→', '→')

console.log(mapper.replace('a → b')) // outputs 'a → b'

```

---

## ✨ Examples

`example.ts`

```ts

import { MappedReplacer } from '@igor.dvlpr/mapped-replacer'

const mapper: MappedReplacer = new MappedReplacer()

mapper.addRule('→', '→')

console.log(mapper.replace('a → b')) // outputs 'a → b'

```

---

## 📝 Changelog

📑 The changelog is available here: [CHANGELOG.md](https://github.com/igorskyflyer/npm-mapped-replacer/blob/main/CHANGELOG.md).

---

## 🪪 License

Licensed under the MIT license which is available here, [MIT license](https://github.com/igorskyflyer/npm-mapped-replacer/blob/main/LICENSE).

---

## 🧬 Related

[@igor.dvlpr/str-is-in](https://www.npmjs.com/package/@igor.dvlpr/str-is-in)

> _🧵 Provides ways of checking whether a String is present in an Array of Strings using custom Comparators. 🔍_




[@igor.dvlpr/duoscribi](https://www.npmjs.com/package/@igor.dvlpr/duoscribi)

> _✒ DúöScríbî allows you to convert letters with diacritics to regular letters. 🤓_




[@igor.dvlpr/strip-yaml-front-matter](https://www.npmjs.com/package/@igor.dvlpr/strip-yaml-front-matter)

> _🦓 Strips YAML front matter from a String or a file. 👾_




[@igor.dvlpr/encode-entities](https://www.npmjs.com/package/@igor.dvlpr/encode-entities)

> _🏃‍♂️ Fast and simple Map and RegExp based HTML entities encoder. 🍁_




[@igor.dvlpr/strip-html](https://www.npmjs.com/package/@igor.dvlpr/strip-html)

> _🥞 Removes HTML code from the given string. Can even extract text-only from the given an HTML string. ✨_

---




### 👨🏻‍💻 Author

Created by **Igor Dimitrijević** ([*@igorskyflyer*](https://github.com/igorskyflyer/)).

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/igorskyflyer/npm-mapped-replacer

Awesome Lists containing this project

README

🗺 Mapped Replacer 🍁

💖 Support further development