character-entities
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.1 • Public • Published

    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.

    Related

    Contribute

    Yes please! See How to Contribute to Open Source.

    License

    MIT © Titus Wormer

    Install

    npm i character-entities

    DownloadsWeekly Downloads

    6,565,208

    Version

    2.0.1

    License

    MIT

    Unpacked Size

    46 kB

    Total Files

    5

    Last publish

    Collaborators

    • wooorm