htmled

htmled

A simple JavaScript library for encoding and decoding HTML entities.

Installation

npm

npm install htmled

Browser

You can also use htmled directly in the browser via jsDelivr:

Using Latest Version (Main Branch)

<script src="https://cdn.jsdelivr.net/gh/SH20RAJ/htmled@main/htmled.min.js"></script>

Using Specific Version (npm Package)

<script src="https://cdn.jsdelivr.net/npm/htmled/htmled.min.js"></script>

Usage

CommonJS (Node.js)

// Import the Library
const htmled = require('htmled');

// Encode HTML Entities
const encoded = htmled.encode(`This is a <b>sample</b> string with some special characters like <>&'`);
console.log('Encoded HTML:', encoded);

// Decode HTML Entities
const decoded = htmled.decode('This is a &lt;b&gt;sample&lt;/b&gt; string with some special characters like &lt;&gt;&amp;\'');
console.log('Decoded HTML:', decoded);

Browser (Global)

If you're using htmled directly in the browser, it will be available as a global variable htmled.

<script src="https://cdn.jsdelivr.net/gh/SH20RAJ/htmled@main/htmled.min.js"></script>
<script>
  // Encode HTML Entities
  const encoded = htmled.encode(`This is a <b>sample</b> string with some special characters like <>&'`);
  console.log('Encoded HTML:', encoded);

  // Decode HTML Entities
  const decoded = htmled.decode('This is a &lt;b&gt;sample&lt;/b&gt; string with some special characters like &lt;&gt;&amp;\'');
  console.log('Decoded HTML:', decoded);
</script>

API

htmled.encode(html)

• html: The HTML string to encode.

Returns the encoded HTML string with HTML entities replaced.

htmled.decode(html)

• html: The HTML string to decode.

Returns the decoded HTML string with HTML entities converted back to characters.

Example

const htmled = require('htmled');

// Encode HTML
const encoded = htmled.encode(`<p>This is a <b>bold</b> statement.</p>`);
console.log('Encoded HTML:', encoded);

// Decode HTML
const decoded = htmled.decode('&lt;p&gt;This is a &lt;b&gt;bold&lt;/b&gt; statement.&lt;/p&gt;');
console.log('Decoded HTML:', decoded);

License

This project is licensed under the MIT License - see the LICENSE file for details.