{"id":15413505,"url":"https://github.com/wooorm/character-entities","last_synced_at":"2025-04-15T06:12:24.080Z","repository":{"id":57197023,"uuid":"43249943","full_name":"wooorm/character-entities","owner":"wooorm","description":"Map of named character references.","archived":false,"fork":false,"pushed_at":"2023-11-01T11:42:49.000Z","size":138,"stargazers_count":10,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-15T06:12:14.318Z","etag":null,"topics":["character","entity","html","reference"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wooorm.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":"funding.yml","license":"license","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"wooorm"}},"created_at":"2015-09-27T14:36:46.000Z","updated_at":"2024-11-27T11:09:04.000Z","dependencies_parsed_at":"2022-09-08T11:50:28.744Z","dependency_job_id":"562a76d8-316d-421b-83b7-611b62824a8c","html_url":"https://github.com/wooorm/character-entities","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wooorm%2Fcharacter-entities","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wooorm%2Fcharacter-entities/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wooorm%2Fcharacter-entities/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wooorm%2Fcharacter-entities/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wooorm","download_url":"https://codeload.github.com/wooorm/character-entities/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249016638,"owners_count":21198833,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["character","entity","html","reference"],"created_at":"2024-10-01T16:57:26.921Z","updated_at":"2025-04-15T06:12:24.064Z","avatar_url":"https://github.com/wooorm.png","language":"JavaScript","funding_links":["https://github.com/sponsors/wooorm"],"categories":[],"sub_categories":[],"readme":"# character-entities\n\n[![Build][build-badge]][build]\n[![Coverage][coverage-badge]][coverage]\n[![Downloads][downloads-badge]][downloads]\n[![Size][size-badge]][size]\n\nMap of named character references.\n\n## Contents\n\n*   [What is this?](#what-is-this)\n*   [When should I use this?](#when-should-i-use-this)\n*   [Install](#install)\n*   [Use](#use)\n*   [API](#api)\n    *   [`characterEntities`](#characterentities)\n*   [Data](#data)\n*   [Types](#types)\n*   [Compatibility](#compatibility)\n*   [Security](#security)\n*   [Related](#related)\n*   [Contribute](#contribute)\n*   [License](#license)\n\n## What is this?\n\nThis is a map of named character references in HTML (latest) to the characters\nthey represent.\n\n## When should I use this?\n\nMaybe when you’re writing an HTML parser or minifier, but otherwise probably\nnever!\nEven then, it might be better to use [`parse-entities`][parse-entities] or\n[`stringify-entities`][stringify-entities].\n\n## Install\n\nThis package is [ESM only][esm].\nIn Node.js (version 16.0+), install with [npm][]:\n\n```sh\nnpm install character-entities\n```\n\nIn Deno with [`esm.sh`][esmsh]:\n\n```js\nimport {characterEntities} from 'https://esm.sh/character-entities@2'\n```\n\nIn browsers with [`esm.sh`][esmsh]:\n\n```html\n\u003cscript type=\"module\"\u003e\n  import {characterEntities} from 'https://esm.sh/character-entities@2?bundle'\n\u003c/script\u003e\n```\n\n## Use\n\n```js\nimport {characterEntities} from 'character-entities'\n\nconsole.log(characterEntities.AElig) // =\u003e 'Æ'\nconsole.log(characterEntities.aelig) // =\u003e 'æ'\nconsole.log(characterEntities.amp) // =\u003e '\u0026'\n```\n\n## API\n\nThis package exports the identifier\n[`characterEntities`][api-character-entities].\nThere is no default export.\n\n### `characterEntities`\n\nMap between (case-sensitive) character entity names to replacements\n(`Record\u003cstring, string\u003e`).\n\n## Data\n\nSee [`html.spec.whatwg.org`][html] for more info.\n\n## Types\n\nThis package is fully typed with [TypeScript][].\nIt exports no additional types.\n\n## Compatibility\n\nThis package is at least compatible with all maintained versions of Node.js.\nAs of now, that is Node.js 16.0+.\nIt also works in Deno and modern browsers.\n\n## Security\n\nThis package is safe.\n\n## Related\n\n*   [`parse-entities`](https://github.com/wooorm/parse-entities)\n    — decode character references\n*   [`stringify-entities`](https://github.com/wooorm/stringify-entities)\n    — encode character references\n*   [`character-entities-html4`](https://github.com/wooorm/character-entities-html4)\n    — info on named character references in HTML 4\n*   [`character-reference-invalid`](https://github.com/wooorm/character-reference-invalid)\n    — info on invalid numeric character references\n*   [`character-entities-legacy`](https://github.com/wooorm/character-entities-legacy)\n    — info on legacy named character references\n\n## Contribute\n\nYes please!\nSee [How to Contribute to Open Source][contribute].\n\n## License\n\n[MIT][license] © [Titus Wormer][author]\n\n\u003c!-- Definitions --\u003e\n\n[build-badge]: https://github.com/wooorm/character-entities/workflows/main/badge.svg\n\n[build]: https://github.com/wooorm/character-entities/actions\n\n[coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/character-entities.svg\n\n[coverage]: https://codecov.io/github/wooorm/character-entities\n\n[downloads-badge]: https://img.shields.io/npm/dm/character-entities.svg\n\n[downloads]: https://www.npmjs.com/package/character-entities\n\n[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size\u0026query=$.size.compressedSize\u0026url=https://deno.bundlejs.com/?q=character-entities\n\n[size]: https://bundlejs.com/?q=character-entities\n\n[npm]: https://docs.npmjs.com/cli/install\n\n[esmsh]: https://esm.sh\n\n[license]: license\n\n[author]: https://wooorm.com\n\n[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c\n\n[typescript]: https://www.typescriptlang.org\n\n[contribute]: https://opensource.guide/how-to-contribute/\n\n[parse-entities]: https://github.com/wooorm/parse-entities\n\n[stringify-entities]: https://github.com/wooorm/stringify-entities\n\n[html]: https://html.spec.whatwg.org/multipage/syntax.html#named-character-references\n\n[api-character-entities]: #characterentities\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwooorm%2Fcharacter-entities","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwooorm%2Fcharacter-entities","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwooorm%2Fcharacter-entities/lists"}