├── index.d.ts ├── node.mjs ├── node.cjs ├── browser.mjs ├── README.md ├── package.json ├── LICENSE └── .gitignore /index.d.ts: -------------------------------------------------------------------------------- 1 | export function decode(value: string): string; 2 | -------------------------------------------------------------------------------- /node.mjs: -------------------------------------------------------------------------------- 1 | import { decodeHTML5 } from 'entities' 2 | const ENTITY_RE = /&([a-z0-9]+|#[0-9]{1,6}|#x[0-9a-fA-F]{1,6});?/gi; 3 | 4 | export function decode(value) { 5 | ENTITY_RE.lastIndex = 0; 6 | return value.replace(ENTITY_RE, (m) => decodeHTML5(m)); 7 | } 8 | -------------------------------------------------------------------------------- /node.cjs: -------------------------------------------------------------------------------- 1 | const { decodeHTML5 } = require('entities'); 2 | const ENTITY_RE = /&([a-z0-9]+|#[0-9]{1,6}|#x[0-9a-fA-F]{1,6});?/gi; 3 | 4 | exports.decode = function decode(value) { 5 | ENTITY_RE.lastIndex = 0; 6 | return value.replace(ENTITY_RE, (m) => decodeHTML5(m)); 7 | } 8 | -------------------------------------------------------------------------------- /browser.mjs: -------------------------------------------------------------------------------- 1 | const ENTITY_RE = /&([a-z0-9]+|#[0-9]{1,6}|#x[0-9a-fA-F]{1,6});?/gi; 2 | 3 | let p; 4 | function decodeHTML5(value) { 5 | if (!p) p = new DOMParser(); 6 | return p.parseFromString(value, 'text/html').documentElement.textContent; 7 | } 8 | 9 | export function decode(value) { 10 | ENTITY_RE.lastIndex = 0; 11 | return value.replace(ENTITY_RE, (m) => decodeHTML5(m)); 12 | } 13 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # `tiny-decode` 2 | 3 | Decoding [HTML named character references](https://html.spec.whatwg.org/multipage/named-characters.html#named-character-references) traditionally requires a large table to store entity names and the code points to which they refer. Unless you take extreme care, this data can easily end up in your JavaScript bundle. 4 | 5 | `tiny-decode` takes advantage of [export conditions](https://nodejs.org/api/packages.html#packages_conditional_exports) to include only as much JavaScript as necessary. For bundled browser code, the `decode` function is only a few bytes. For server-side code, `decode` includes the full [`entities`](https://github.com/fb55/entities) module, which is much larger. 6 | 7 | ## Example 8 | 9 | ``` 10 | Bundle `entities` 18.52 kB │ gzip: 19.64 kB 11 | Bundle `tiny-decode` 0.97 kB │ gzip: 0.56 kB 12 | ``` 13 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "tiny-decode", 3 | "type": "module", 4 | "version": "0.1.3", 5 | "description": "Decode HTML entities the browser-friendly way", 6 | "exports": { 7 | ".": { 8 | "types": "./index.d.ts", 9 | "browser": "./browser.mjs", 10 | "import": "./node.mjs", 11 | "require": "./node.cjs", 12 | "default": "./node.mjs" 13 | } 14 | }, 15 | "repository": { 16 | "type": "git", 17 | "url": "git+https://github.com/natemoo-re/tiny-decode.git" 18 | }, 19 | "keywords": [ 20 | "html", 21 | "entities", 22 | "decode" 23 | ], 24 | "author": "Nate Moore", 25 | "license": "MIT", 26 | "bugs": { 27 | "url": "https://github.com/natemoo-re/tiny-decode/issues" 28 | }, 29 | "homepage": "https://github.com/natemoo-re/tiny-decode#readme", 30 | "dependencies": { 31 | "entities": "^4.4.0" 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License Copyright (c) 2023 Nate Moore 2 | 3 | Permission is hereby granted, free of 4 | charge, to any person obtaining a copy of this software and associated 5 | documentation files (the "Software"), to deal in the Software without 6 | restriction, including without limitation the rights to use, copy, modify, merge, 7 | publish, distribute, sublicense, and/or sell copies of the Software, and to 8 | permit persons to whom the Software is furnished to do so, subject to the 9 | following conditions: 10 | 11 | The above copyright notice and this permission notice 12 | (including the next paragraph) shall be included in all copies or substantial 13 | portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF 16 | ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 17 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO 18 | EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR 19 | OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 20 | FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 21 | THE SOFTWARE. -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | lerna-debug.log* 8 | .pnpm-debug.log* 9 | 10 | # Diagnostic reports (https://nodejs.org/api/report.html) 11 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json 12 | 13 | # Runtime data 14 | pids 15 | *.pid 16 | *.seed 17 | *.pid.lock 18 | 19 | # Directory for instrumented libs generated by jscoverage/JSCover 20 | lib-cov 21 | 22 | # Coverage directory used by tools like istanbul 23 | coverage 24 | *.lcov 25 | 26 | # nyc test coverage 27 | .nyc_output 28 | 29 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) 30 | .grunt 31 | 32 | # Bower dependency directory (https://bower.io/) 33 | bower_components 34 | 35 | # node-waf configuration 36 | .lock-wscript 37 | 38 | # Compiled binary addons (https://nodejs.org/api/addons.html) 39 | build/Release 40 | 41 | # Dependency directories 42 | node_modules/ 43 | jspm_packages/ 44 | 45 | # Snowpack dependency directory (https://snowpack.dev/) 46 | web_modules/ 47 | 48 | # TypeScript cache 49 | *.tsbuildinfo 50 | 51 | # Optional npm cache directory 52 | .npm 53 | 54 | # Optional eslint cache 55 | .eslintcache 56 | 57 | # Optional stylelint cache 58 | .stylelintcache 59 | 60 | # Microbundle cache 61 | .rpt2_cache/ 62 | .rts2_cache_cjs/ 63 | .rts2_cache_es/ 64 | .rts2_cache_umd/ 65 | 66 | # Optional REPL history 67 | .node_repl_history 68 | 69 | # Output of 'npm pack' 70 | *.tgz 71 | 72 | # Yarn Integrity file 73 | .yarn-integrity 74 | 75 | # dotenv environment variable files 76 | .env 77 | .env.development.local 78 | .env.test.local 79 | .env.production.local 80 | .env.local 81 | 82 | # parcel-bundler cache (https://parceljs.org/) 83 | .cache 84 | .parcel-cache 85 | 86 | # Next.js build output 87 | .next 88 | out 89 | 90 | # Nuxt.js build / generate output 91 | .nuxt 92 | dist 93 | 94 | # Gatsby files 95 | .cache/ 96 | # Comment in the public line in if your project uses Gatsby and not Next.js 97 | # https://nextjs.org/blog/next-9-1#public-directory-support 98 | # public 99 | 100 | # vuepress build output 101 | .vuepress/dist 102 | 103 | # vuepress v2.x temp and cache directory 104 | .temp 105 | .cache 106 | 107 | # Docusaurus cache and generated files 108 | .docusaurus 109 | 110 | # Serverless directories 111 | .serverless/ 112 | 113 | # FuseBox cache 114 | .fusebox/ 115 | 116 | # DynamoDB Local files 117 | .dynamodb/ 118 | 119 | # TernJS port file 120 | .tern-port 121 | 122 | # Stores VSCode versions used for testing VSCode extensions 123 | .vscode-test 124 | 125 | # yarn v2 126 | .yarn/cache 127 | .yarn/unplugged 128 | .yarn/build-state.yml 129 | .yarn/install-state.gz 130 | .pnp.* 131 | --------------------------------------------------------------------------------