🗺 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

🕵🏼 Usage

Install it by executing:

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

🤹🏼 API

addRule(key: string, value: string): boolean

Adds a new rule or updates the existing rule for character replacing.

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 😀'

addRules(rules: Object): boolean

Adds rules or updates the existing rules for character replacing. Passed object is a simple key-value object, i.e. { '<': '&#60;', '>': '&#62;'}

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

const mapper: MappedReplacer = new MappedReplacer()

mapper.addRules({
  '𝕋': '𝕋',
  '≈': '≈',
  '𝔱': '𝔱',
})

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

removeRule(key: string): boolean

Removes the rule that matches the provided key.

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 character replacing.

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.

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 that match the keys in the Map object.

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

const mapper: MappedReplacer = new MappedReplacer()

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

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

---

🪪 License

Licensed under the MIT license which is available here, MIT license.

---

🧬 Related

@igor.dvlpr/zep

🧠 Zep is a zero-dependency, efficient debounce module. ⏰

@igor.dvlpr/strip-html

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

@igor.dvlpr/registry-apppaths

🪀 A Node.js module for reading the AppPaths registry key on Windows. Useful for retrieving applications that can be launched from the command prompt. 🗃

@igor.dvlpr/adblock-filter-counter

🐲 A dead simple npm module that counts Adblock filter rules.🦘

@igor.dvlpr/unc-path

🥽 Provides ways of parsing UNC paths and checking whether they are valid. 🎱

Provided by Igor Dimitrijević (@igorskyflyer).