📃 Table of contents

• Usage
• API
  • constructor()
  • addRule(replaceWith: string, searchFor: string)
  • addRule(replaceWith: string, searchFor: string[])
  • addRules(rules: { [key: string]: string })
  • addRules(rules: { [key: string]: string[] })
  • hasRule(rules: string)
  • removeRule()
  • rulesCount()
  • clearRules()
  • replace()
• Examples
• Changelog
• License
• Related
• Author

🕵🏼 Usage

Install it by executing:

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.

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.

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.:

{
  '&#60;' : '<',
  '&#62;' : '>'
}

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

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.:

{
  '😁' : [':D', ':-D'],
  '😛' : [':P', ':-P']
}

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

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.

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.

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.

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 with the values from the Map.

input - The input string.

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

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.

🪪 License

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

🧬 Related

@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

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

@igor.dvlpr/strip-yaml-front-matter

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

@igor.dvlpr/encode-entities

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

@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).