htmlencode

library0.0.5jsnpmunverified

htmlencode is a minimalist Node.js module, currently at version 0.0.5, designed to provide basic HTML encoding and decoding functionalities. It serves as a wrapper for the legacy client-side JavaScript library found at `strictly-software.com/htmlencode`, adapting it for server-side Node.js environments. The package introduced two key modifications to the original source: renaming the global `Encoder` object to `module.exports` for CommonJS compatibility and patching a global variable leak within the `htmlDecode` method. Given its low version number and the nature of its changes (primarily adapting an external, presumably old, client-side script for Node.js), the package appears to have had a very limited release cadence and is likely no longer actively maintained. It offers basic HTML entity conversion, supporting both named and numerical entities, configured either globally via the `EncodeType` property or through an `Encoder` class instance.

serialization

npm install htmlencode

github ↗package ↗

INSTALL

IMPORT

SIG · HTMLENCODE

htmlencode

serializationjavascriptv0.0.5

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

htmlencode

✓ const htmlencode = require('htmlencode');

✗ import htmlencode from 'htmlencode';

This package is CommonJS-only. The main export is an object containing encoding/decoding methods and the Encoder class.

htmlEncode

✓ const { htmlEncode } = require('htmlencode');

✗ import { htmlEncode } from 'htmlencode';

Access individual methods directly from the main module object. CommonJS-only.

Encoder

✓ const { Encoder } = require('htmlencode');

✗ import { Encoder } from 'htmlencode';

The Encoder class is exposed as a property of the main module export. CommonJS-only.

Demonstrates basic HTML encoding and decoding, global entity type changes, and instance-specific encoding using the Encoder class.

const htmlencode = require('htmlencode'); // Basic HTML encoding with default named entities const encodedNamed = htmlencode.htmlEncode('<h1>Welcome to my & website!</h1>'); console.log('Encoded (named entities):', encodedNamed); // Expected: <h1>Welcome to my & website!</h1> // Decoding example const decoded = htmlencode.htmlDecode('<h1>Welcome</h1>'); console.log('Decoded:', decoded); // Expected: <h1>Welcome</h1> // Changing to numerical HTML entities globally htmlencode.EncodeType = 'numerical'; const encodedNumerical = htmlencode.htmlEncode('<h1>Another & test</h1>'); console.log('Encoded (numerical entities):', encodedNumerical); // Expected: <h1>Another & test</h1> // Using the Encoder class for instance-specific settings const Encoder = htmlencode.Encoder; // Access the class const encoderInstance = new Encoder('named'); // Or 'numerical' const instanceEncoded = encoderInstance.htmlEncode('<script>alert("XSS")</script>'); console.log('Encoded (instance-specific named):', instanceEncoded); // Expected: <script>alert("XSS")</script>

Debug

Known issues

breakingThis package is effectively abandoned and unmaintained. It is at version 0.0.5 with no updates since its initial release, meaning it will not receive security patches, bug fixes, or compatibility updates for modern Node.js versions or evolving web standards.

fix

Migrate to a actively maintained and more robust HTML sanitization/encoding library like 'dompurify' or 'sanitize-html', or a dedicated encoding library like 'he'.

affects: >=0.0.0

gotchaThe package is exclusively CommonJS-only (`require()`). Attempting to use `import` statements in an ECMAScript Module (ESM) context will lead to runtime errors, or require specific build tool configurations or Node.js loader hacks.

fix

Ensure your project is configured for CommonJS, or use dynamic `import()` or `createRequire` from the `module` module to load it within an ESM context. Consider modern alternatives that support ESM.

affects: >=0.0.0

breakingAs a wrapper around an unmaintained client-side library, `htmlencode` likely contains unaddressed security vulnerabilities, particularly concerning HTML encoding/decoding which is critical for preventing Cross-Site Scripting (XSS) attacks. Its use in production without thorough security review is strongly discouraged.

fix

Immediately replace this package with a security-audited and actively maintained library specifically designed for HTML sanitization or secure encoding, such as 'dompurify', 'sanitize-html', or 'he'.

affects: >=0.0.0

gotchaThe package does not ship with TypeScript type definitions. This makes it challenging to use in TypeScript projects, requiring manual `declare module` additions or ignoring type errors.

fix

If you must use this package, create a `declarations.d.ts` file with `declare module 'htmlencode';` or more specific type definitions. However, migrating to a typed alternative is recommended.

affects: >=0.0.0

Errors

Common errors & fixes

ReferenceError: require is not defined

Attempting to use `require()` in an ECMAScript Module (ESM) context, where `require` is not globally available.

fix

This package is CommonJS-only. Either convert your Node.js project or file to CommonJS (`.js` files treated as CJS, or explicitly `.cjs`), or use Node.js's `createRequire` utility in ESM to load it: `import { createRequire } from 'module'; const require = createRequire(import.meta.url); const htmlencode = require('htmlencode');`

TypeError: htmlEncode is not a function

This error typically occurs when attempting to use named imports (`import { htmlEncode } from 'htmlencode';`) for a CommonJS-only package that exports a single object, or when the module object is not correctly accessed.

fix

For CommonJS, use `const htmlencode = require('htmlencode');` to get the module object, then access its methods like `htmlencode.htmlEncode()`. Direct named imports are not supported for this package.

Upgrade

Version history

0.0.5latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/danmactough/node-htmlencode ↗

packagehttps://www.npmjs.com/package/htmlencode ↗