🗺 Mapped Replacer 🍁

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

Requires ES6 or later, for compatibility check this Can I Use link.

✨Since v.1.1.0 Mapped Replacer is a hybrid module that supports both CommonJS (legacy) and ES modules, thanks to Modern Module.

Table of contents

• Install
• API
  • addRule()
  • addRules()
  • removeRule()
  • rulesCount()
  • clearRules()
  • replace()
• Test

Install

npm i mapped-replacer

API

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

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

import { MappedReplacer } from 'mapped-replacer'

const mapper = 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 'mapped-replacer'

const mapper = new MappedReplacer()

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

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

removeRule(key: string): boolean

Removes the rule that matches the provided key.

import { MappedReplacer } from 'mapped-replacer'

const mapper = 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 'mapped-replacer'

const mapper = new MappedReplacer()

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

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

clearRules(): void

Clears all the rules.

import { MappedReplacer } from 'mapped-replacer'

const mapper = 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 'mapped-replacer'

const mapper = new MappedReplacer()

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

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

Test

npm test