File size: 3,232 Bytes
bc20498 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 |
# decode-named-character-reference
[![Build Status][build-badge]][build]
[![Coverage Status][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
Decode named character references.
## Contents
* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [Use](#use)
* [API](#api)
* [`decodeNamedCharacterReference(value)`](#decodenamedcharacterreferencevalue)
* [Types](#types)
* [Compatibility](#compatibility)
* [Security](#security)
* [Related](#related)
* [Contribute](#contribute)
* [License](#license)
## What is this?
A workaround for webpack.
## When should I use this?
Never use this.
Use [`parse-entities`][parse-entities].
It uses this.
## Install
This package is [ESM only][esm].
In Node.js (version 12.20+, 14.14+, or 16.0+), install with [npm][]:
```sh
npm install decode-named-character-reference
```
In Deno with [`esm.sh`][esmsh]:
```js
import {decodeNamedCharacterReference} from 'https://esm.sh/decode-named-character-reference@1'
```
In browsers with [`esm.sh`][esmsh]:
```html
<script type="module">
import {decodeNamedCharacterReference} from 'https://esm.sh/decode-named-character-reference@1?bundle'
</script>
```
## Use
```js
import {decodeNamedCharacterReference} from 'decode-named-character-reference'
decodeNamedCharacterReference('amp') //=> '&'
```
## API
This package exports the following identifier: `decodeNamedCharacterReference`.
There is no default export.
### `decodeNamedCharacterReference(value)`
Again, use [`parse-entities`][parse-entities].
## 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
* [`parse-entities`][parse-entities]
— parse (decode) HTML character references
## Contribute
Yes please!
See [How to Contribute to Open Source][contribute].
## License
[MIT][license] © [Titus Wormer][author]
<!-- Definitions -->
[build-badge]: https://github.com/wooorm/decode-named-character-reference/workflows/main/badge.svg
[build]: https://github.com/wooorm/decode-named-character-reference/actions
[coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/decode-named-character-reference.svg
[coverage]: https://codecov.io/github/wooorm/decode-named-character-reference
[downloads-badge]: https://img.shields.io/npm/dm/decode-named-character-reference.svg
[downloads]: https://www.npmjs.com/package/decode-named-character-reference
[size-badge]: https://img.shields.io/bundlephobia/minzip/decode-named-character-reference.svg
[size]: https://bundlephobia.com/result?p=decode-named-character-reference
[npm]: https://docs.npmjs.com/cli/install
[esmsh]: https://esm.sh
[license]: license
[author]: https://wooorm.com
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[typescript]: https://www.typescriptlang.org
[contribute]: https://opensource.guide/how-to-contribute/
[parse-entities]: https://github.com/wooorm/parse-entities
|