You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 7-8.RSVP
Socket
Socket
Sign inDemoInstall

character-reference-invalid

Package Overview
Dependencies
Maintainers
1
Versions
9
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

character-reference-invalid

Map of invalid numeric character references to their replacements, according to HTML


Version published
Weekly downloads
6.3M
decreased by-17.11%
Maintainers
1
Install size
9.38 kB
Created
Weekly downloads
 

Package description

What is character-reference-invalid?

The character-reference-invalid npm package provides utilities for handling invalid character references in HTML and XML documents. It is primarily used to encode and decode invalid characters to ensure that text is safely and correctly processed in web applications and other environments that handle HTML/XML content.

What are character-reference-invalid's main functionalities?

Decoding invalid character references

This feature allows the decoding of invalid character references into their respective Unicode representations, which is useful for processing or sanitizing input data in web applications.

const cri = require('character-reference-invalid');
console.log(cri.decode('�')); // Outputs: \\uD800

Encoding characters to invalid references

This feature enables the encoding of characters into their equivalent invalid character references. This is particularly useful when you need to generate HTML or XML output that includes characters that might otherwise be handled incorrectly by some parsers.

const cri = require('character-reference-invalid');
console.log(cri.encode(String.fromCodePoint(0xD800))); // Outputs: '�'

Other packages similar to character-reference-invalid

Readme

Source

character-reference-invalid

Build Coverage Downloads Size

Map of invalid numeric character references to their replacements, according to HTML.

Contents

What is this?

This is a map from the HTML spec of C1 ASCII/Unicode control characters (which are disallowed by HTML) to the characters those code points would have in Windows 1252. For example, U+0080 (Padding Character) maps to , because that’s used for 0x80 in Windows 1252.

When should I use this?

Probably never, unless you’re dealing with parsing HTML or similar XML-like things, or in a place where Unicode is not the primary encoding (it is in most places).

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:

npm install character-reference-invalid

In Deno with Skypack:

import {characterReferenceInvalid} from 'https://cdn.skypack.dev/character-reference-invalid@2?dts'

In browsers with Skypack:

<script type="module">
  import {characterReferenceInvalid} from 'https://cdn.skypack.dev/character-reference-invalid@2?min'
</script>

Use

import {characterReferenceInvalid} from 'character-reference-invalid'

console.log(characterReferenceInvalid[0x80]) // => '€'
console.log(characterReferenceInvalid[0x89]) // => '‰'
console.log(characterReferenceInvalid[0x99]) // => '™'

API

This package exports the following identifiers: characterReferenceInvalid. There is no default export.

characterReferenceInvalid

Record<number, string> — mapping between invalid numeric character reference codes to replacements characters.

Source

See html.spec.whatwg.org.

Types

This package is fully typed with TypeScript.

Compatibility

This package is at least compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. It also works in Deno and modern browsers.

Security

This package is safe.

Contribute

Yes please! See How to Contribute to Open Source.

License

MIT © Titus Wormer

Keywords

FAQs

Package last updated on 27 Oct 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc