@igor.dvlpr/mapped-replacer NPM

📃 Table of contents

🕵🏼 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({
  '&#120139;' : '𝕋',
  '&#8776;' : '≈',
  '&#120113;' : '𝔱'
})

console.log(mapper.replace('𝕋 ≈ 𝔱')) // outputs '&#120139; &#8776; &#120113;'

`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('&#120139;', '𝕋')
mapper.addRule('&#8776;', '≈')

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('&#120139;', '𝕋')
mapper.addRule('&#8776;', '≈')

mapper.removeRule('𝕋')

console.log(mapper.replace('𝕋 ≈ 𝔱')) // outputs '𝕋 &#8776; 𝔱'

`rulesCount(): number`

Gets the number of rules for string replacing.

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

const mapper: MappedReplacer = new MappedReplacer()

mapper.addRule('&#120139;', '𝕋')

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('&#120139;', '𝕋')
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('&#8594;', '→')

console.log(mapper.replace('a → b')) // outputs 'a &#8594; b'

✨ Examples

example.ts

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

const mapper: MappedReplacer = new MappedReplacer()

mapper.addRule('&#8594;', '→')

console.log(mapper.replace('a → b')) // outputs 'a &#8594; b'