📃 Table of Contents

• Features
• Usage
• API
• Changelog
• Support
• License
• Related
• Author

🤖 Features

• ⚡ Instant HTML encoding for special characters
• 🛠 Add your own custom encoding rules
• ♻ Reset back to default rules anytime
• ✏️ Update individual rules on the fly
• ❌ Remove unwanted rules easily
• 📊 See exactly how many rules are active
• 🚀 Single‑pass, high‑performance replacement engine (powered by @igorskyflyer/mapped-replacer)

🛡 SECURITY

Encoding of special characters into HTML entities helps mitigate XSS risks in the textual layer by ensuring user‑supplied content is treated as text, not executable code.

Note: not a full XSS solution, usage of other XSS-prevention techniques is still required.

🕵🏼 Usage

Install it by executing any of the following, depending on your preferred package manager:

pnpm add @igorskyflyer/encode-entities

yarn add @igorskyflyer/encode-entities

npm i @igorskyflyer/encode-entities

🤹🏼 API

💡 TIP

Encoded by default: <, >, ", ', &, =, `, !, @, $, %, (, ), +, {, }, [, ].

You can however remove any of these rules and/or add your own.

resetRules(): void

Resets the rules to the default ones.

import { Encoder } from '@igorskyflyer/encode-entities'

const encoder: Encoder = new Encoder()

encoder.updateRule('😀', '<')
encoder.updateRule('😂', '>')
encoder.resetRules()

console.log(encoder.encode('<strong>')) // outputs '&#60;strong&#62;'

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

Adds a new rule for entities encoding. Returns true if the rule was added successfully or false if not.

import { Encoder } from '@igorskyflyer/encode-entities'

const encoder: Encoder = new Encoder()
encoder.addRule('→', '→')

console.log(encoder.encode('<a href="#">→</a>')) // outputs '&#60;a href&#61;&#34;#&#34;&#62;&#8594;&#60;/a&#62;'

updateRule(replaceWith: string, searchFor: string): boolean

Updates an existing rule for entity encoding. Returns true if the rule was updated successfully or false if not.

import { Encoder } from '@igorskyflyer/encode-entities'

const encoder: Encoder = new Encoder()
encoder.addRule('←', '→')
encoder.updateRule('→', '→')

console.log(encoder.encode('<a href="#">→</a>')) // outputs '&#60;a href&#61;&#34;#&#34;&#62;&#8594;&#60;/a&#62;'

addRules(rules: Object): boolean

Adds rules for entity encoding. Passed object is a simple key-value object, i.e. { '<': '&#60;', '>': '&#62;' } Returns true if the rules were added successfully or false if not.

import { Encoder } from '@igorskyflyer/encode-entities'

const encoder: Encoder = new Encoder()

encoder.addRules({
  '𝕋':'𝕋'
  '≈':'≈'
  '𝔱':'𝔱'
})

console.log(encoder.encode('<span>𝕋 ≈ 𝔱</span>')) // outputs '&#60;span&#62;&#120139; &#8776; &#120113;&#60;/span&#62;'

removeRule(key: string): boolean

Removes the rule that matches the provided key. Returns true if the rule was removed successfully or false if not.

import { Encoder } from '@igorskyflyer/encode-entities'

const encoder: Encoder = new Encoder()

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

console.log(encoder.rulesCount()) // outputs 20

rulesCount(): number

Gets the number of rules for entity encoding.

import { Encoder } from '@igorskyflyer/encode-entities'

const encoder: Encoder = new Encoder()

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

console.log(encoder.rulesCount()) // outputs 21

encode()

Encodes special characters in the given string to HTML entities.

import { Encoder } from '@igorskyflyer/encode-entities'

const encoder: Encoder = new Encoder()

console.log(encoder.encode('<strong>')) // outputs '&#60;strong&#62;'

📝 Changelog

📑 The changelog is available here, CHANGELOG.md.

🪪 License

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

💖 Support

🧬 Related

@igorskyflyer/str-is-in

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

@igorskyflyer/aria

🧬 Meet Aria, an efficient Adblock filter list compiler, with many features that make your maintenance of Adblock filter lists a breeze! 🗡

@igorskyflyer/pathexists

🧲 Provides ways of properly checking if a path exists inside a given array of files/directories both on Windows and UNIX-like operating systems. 🗺

@igorskyflyer/chars-in-string

🪐 Provides ways of testing whether an array of chars is present inside a given String. ☄

@igorskyflyer/valid-path

🧰 Provides ways of testing whether a given value can be a valid file/directory name. 🏜

👨🏻‍💻 Author

Created by Igor Dimitrijević (@igorskyflyer).