Socket
Socket
Sign inDemoInstall

character-entities

Package Overview
Dependencies
0
Maintainers
1
Versions
10
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    character-entities

Map of named character references


Version published
Weekly downloads
9.8M
increased by2.8%
Maintainers
1
Install size
44.9 kB
Created
Weekly downloads
 

Package description

What is character-entities?

The character-entities npm package provides a comprehensive list of character entity references (like & for an ampersand or < for a less-than sign) that can be used in HTML and XML. This package is particularly useful for encoding or decoding character entities in text processing, ensuring that special characters are correctly represented in web pages or XML documents.

What are character-entities's main functionalities?

Accessing Character Entities

This feature allows you to access the character entity for special characters like ampersand (&) and less-than (<) sign. The code sample demonstrates how to import the package and retrieve the character entities for ampersand and less-than sign.

"use strict";
const characterEntities = require('character-entities');
console.log(characterEntities.amp); // Output: '&'
console.log(characterEntities.lt); // Output: '<'

Other packages similar to character-entities

Readme

Source

character-entities

Build Coverage Downloads Size

Map of named character references.

Contents

What is this?

This is a map of named character references in HTML (latest) to the characters they represent.

When should I use this?

Maybe when you’re writing an HTML parser or minifier, but otherwise probably never! Even then, it might be better to use parse-entities or stringify-entities.

Install

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

npm install character-entities

In Deno with Skypack:

import {characterEntities} from 'https://cdn.skypack.dev/character-entities@2?dts'

In browsers with Skypack:

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

Use

import {characterEntities} from 'character-entities'

console.log(characterEntities.AElig) // => 'Æ'
console.log(characterEntities.aelig) // => 'æ'
console.log(characterEntities.amp) // => '&'

API

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

characterEntities

Mapping between (case-sensitive) character entity names to replacements. See html.spec.whatwg.org for more info.

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

Last updated on 29 Oct 2021

Did you know?

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

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc