{"_id":"micromark-util-encode","_rev":"267330","name":"micromark-util-encode","description":"micromark utility to encode dangerous html characters","dist-tags":{"latest":"1.0.1","next":"1.0.0-beta.1"},"maintainers":[{"name":"wooorm","email":""}],"time":{"modified":"2023-03-27T19:09:14.000Z","created":"2021-06-07T09:26:20.308Z","1.0.1":"2021-12-27T18:09:10.874Z","1.0.0":"2021-06-22T19:04:11.444Z","1.0.0-beta.1":"2021-06-20T12:13:22.370Z","1.0.0-alpha.3":"2021-06-16T17:18:38.646Z","1.0.0-alpha.2":"2021-06-07T13:36:01.090Z","1.0.0-alpha.1":"2021-06-07T09:26:20.308Z"},"users":{},"author":{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"},"repository":{"type":"git","url":"git+https://github.com/micromark/micromark.git#main"},"versions":{"1.0.1":{"name":"micromark-util-encode","version":"1.0.1","description":"micromark utility to encode dangerous html characters","license":"MIT","keywords":["micromark","util","utility","html","encode"],"repository":{"type":"git","url":"git+https://github.com/micromark/micromark.git#main"},"bugs":{"url":"https://github.com/micromark/micromark/issues"},"funding":[{"type":"GitHub Sponsors","url":"https://github.com/sponsors/unifiedjs"},{"type":"OpenCollective","url":"https://opencollective.com/unified"}],"author":{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"},"contributors":[{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"}],"sideEffects":false,"type":"module","main":"index.js","types":"index.d.ts","exports":"./index.js","scripts":{"build":"rimraf \"*.d.ts\" && tsc && type-coverage"},"xo":false,"typeCoverage":{"atLeast":100,"detail":true,"strict":true,"ignoreCatch":true},"gitHead":"9a3a2dd28b996049fe7de46d6e6f905d20bf5caf","homepage":"https://github.com/micromark/micromark/tree/main#readme","_id":"micromark-util-encode@1.0.1","_nodeVersion":"17.0.1","_npmVersion":"8.1.0","dist":{"shasum":"2c1c22d3800870ad770ece5686ebca5920353383","size":1919,"noattachment":false,"key":"/micromark-util-encode/-/micromark-util-encode-1.0.1.tgz","tarball":"http://name.csiicloud.com:7001/micromark-util-encode/download/micromark-util-encode-1.0.1.tgz"},"_npmUser":{"name":"wooorm","email":"tituswormer@gmail.com"},"directories":{},"maintainers":[{"name":"wooorm","email":""}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/micromark-util-encode_1.0.1_1640628550763_0.9695955544046908"},"_hasShrinkwrap":false,"_cnpmcore_publish_time":"2021-12-28T04:00:52.754Z","publish_time":1640628550874,"_cnpm_publish_time":1640628550874},"1.0.0":{"name":"micromark-util-encode","version":"1.0.0","description":"micromark utility to encode dangerous html characters","license":"MIT","keywords":["micromark","util","utility","html","encode"],"repository":{"type":"git","url":"git+https://github.com/micromark/micromark.git#main"},"bugs":{"url":"https://github.com/micromark/micromark/issues"},"funding":[{"type":"GitHub Sponsors","url":"https://github.com/sponsors/unifiedjs"},{"type":"OpenCollective","url":"https://opencollective.com/unified"}],"author":{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"},"contributors":[{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"}],"sideEffects":false,"type":"module","main":"index.js","types":"index.d.ts","exports":"./index.js","scripts":{"build":"rimraf \"*.d.ts\" && tsc && type-coverage"},"xo":false,"typeCoverage":{"atLeast":100,"detail":true,"strict":true,"ignoreCatch":true},"homepage":"https://github.com/micromark/micromark/tree/main#readme","_id":"micromark-util-encode@1.0.0","_nodeVersion":"16.2.0","_npmVersion":"7.18.1","dist":{"shasum":"c409ecf751a28aa9564b599db35640fccec4c068","size":1881,"noattachment":false,"key":"/micromark-util-encode/-/micromark-util-encode-1.0.0.tgz","tarball":"http://name.csiicloud.com:7001/micromark-util-encode/download/micromark-util-encode-1.0.0.tgz"},"_npmUser":{"name":"wooorm","email":"tituswormer@gmail.com"},"directories":{},"maintainers":[{"name":"wooorm","email":""}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/micromark-util-encode_1.0.0_1624388651279_0.5513786221303205"},"_hasShrinkwrap":false,"publish_time":1624388651444,"_cnpm_publish_time":1624388651444,"_cnpmcore_publish_time":"2021-12-14T05:34:38.992Z"},"1.0.0-beta.1":{"name":"micromark-util-encode","version":"1.0.0-beta.1","description":"micromark utility to encode dangerous html characters","license":"MIT","keywords":["micromark","util","utility","html","encode"],"repository":{"type":"git","url":"git+https://github.com/micromark/micromark.git#main"},"bugs":{"url":"https://github.com/micromark/micromark/issues"},"funding":[{"type":"GitHub Sponsors","url":"https://github.com/sponsors/unifiedjs"},{"type":"OpenCollective","url":"https://opencollective.com/unified"}],"author":{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"},"contributors":[{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"}],"sideEffects":false,"type":"module","main":"index.js","types":"index.d.ts","exports":"./index.js","scripts":{"build":"rimraf \"*.d.ts\" && tsc && type-coverage"},"xo":false,"typeCoverage":{"atLeast":100,"detail":true,"strict":true,"ignoreCatch":true},"readmeFilename":"readme.md","homepage":"https://github.com/micromark/micromark/tree/main#readme","_id":"micromark-util-encode@1.0.0-beta.1","_nodeVersion":"16.2.0","_npmVersion":"7.18.1","dist":{"shasum":"23915519fa10b85d2370f428d0a55429cc206e3e","size":1890,"noattachment":false,"key":"/micromark-util-encode/-/micromark-util-encode-1.0.0-beta.1.tgz","tarball":"http://name.csiicloud.com:7001/micromark-util-encode/download/micromark-util-encode-1.0.0-beta.1.tgz"},"_npmUser":{"name":"wooorm","email":"tituswormer@gmail.com"},"directories":{},"maintainers":[{"name":"wooorm","email":""}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/micromark-util-encode_1.0.0-beta.1_1624191201880_0.7530754195803355"},"_hasShrinkwrap":false,"publish_time":1624191202370,"_cnpm_publish_time":1624191202370,"_cnpmcore_publish_time":"2021-12-14T05:34:39.225Z"},"1.0.0-alpha.3":{"name":"micromark-util-encode","version":"1.0.0-alpha.3","description":"micromark utility to encode dangerous html characters","license":"MIT","keywords":["micromark","util","utility","html","encode"],"repository":{"type":"git","url":"git+https://github.com/micromark/micromark.git#main"},"bugs":{"url":"https://github.com/micromark/micromark/issues"},"funding":[{"type":"GitHub Sponsors","url":"https://github.com/sponsors/unifiedjs"},{"type":"OpenCollective","url":"https://opencollective.com/unified"}],"author":{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"},"contributors":[{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"}],"sideEffects":false,"type":"module","main":"index.js","types":"index.d.ts","exports":"./index.js","scripts":{"build":"rimraf \"*.d.ts\" && tsc && type-coverage"},"xo":false,"typeCoverage":{"atLeast":100,"detail":true,"strict":true,"ignoreCatch":true},"readmeFilename":"readme.md","homepage":"https://github.com/micromark/micromark/tree/main#readme","_id":"micromark-util-encode@1.0.0-alpha.3","_nodeVersion":"16.2.0","_npmVersion":"7.16.0","dist":{"shasum":"5e825a1176ae7923ff80d61cb9d916fad31d8a3e","size":1889,"noattachment":false,"key":"/micromark-util-encode/-/micromark-util-encode-1.0.0-alpha.3.tgz","tarball":"http://name.csiicloud.com:7001/micromark-util-encode/download/micromark-util-encode-1.0.0-alpha.3.tgz"},"_npmUser":{"name":"wooorm","email":"tituswormer@gmail.com"},"directories":{},"maintainers":[{"name":"wooorm","email":""}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/micromark-util-encode_1.0.0-alpha.3_1623863918471_0.8037835705256311"},"_hasShrinkwrap":false,"publish_time":1623863918646,"_cnpm_publish_time":1623863918646,"_cnpmcore_publish_time":"2021-12-14T05:34:39.441Z"},"1.0.0-alpha.2":{"name":"micromark-util-encode","version":"1.0.0-alpha.2","description":"micromark utility to encode dangerous html characters","license":"MIT","keywords":["micromark","util","utility","html","encode"],"repository":{"type":"git","url":"git+https://github.com/micromark/micromark.git#main"},"bugs":{"url":"https://github.com/micromark/micromark/issues"},"funding":[{"type":"GitHub Sponsors","url":"https://github.com/sponsors/unifiedjs"},{"type":"OpenCollective","url":"https://opencollective.com/unified"}],"author":{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"},"contributors":[{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"}],"sideEffects":false,"type":"module","main":"index.js","types":"index.d.ts","exports":"./index.js","scripts":{"build":"rimraf \"*.d.ts\" && tsc && type-coverage"},"xo":false,"typeCoverage":{"atLeast":100,"detail":true,"strict":true,"ignoreCatch":true},"readmeFilename":"readme.md","homepage":"https://github.com/micromark/micromark/tree/main#readme","_id":"micromark-util-encode@1.0.0-alpha.2","_nodeVersion":"16.2.0","_npmVersion":"7.15.1","dist":{"shasum":"6657e572960a6b056fc43d1e3bb443ea0b8e99d3","size":1892,"noattachment":false,"key":"/micromark-util-encode/-/micromark-util-encode-1.0.0-alpha.2.tgz","tarball":"http://name.csiicloud.com:7001/micromark-util-encode/download/micromark-util-encode-1.0.0-alpha.2.tgz"},"_npmUser":{"name":"wooorm","email":"tituswormer@gmail.com"},"directories":{},"maintainers":[{"name":"wooorm","email":""}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/micromark-util-encode_1.0.0-alpha.2_1623072960956_0.6236010700588241"},"_hasShrinkwrap":false,"publish_time":1623072961090,"_cnpm_publish_time":1623072961090,"_cnpmcore_publish_time":"2021-12-14T05:34:39.677Z"},"1.0.0-alpha.1":{"name":"micromark-util-encode","version":"1.0.0-alpha.1","description":"micromark utility to encode dangerous html characters","license":"MIT","keywords":["micromark","util","utility","html","encode"],"repository":{"type":"git","url":"git+https://github.com/micromark/micromark.git#main"},"bugs":{"url":"https://github.com/micromark/micromark/issues"},"funding":[{"type":"GitHub Sponsors","url":"https://github.com/sponsors/unifiedjs"},{"type":"OpenCollective","url":"https://opencollective.com/unified"}],"author":{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"},"contributors":[{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"}],"type":"module","main":"index.js","types":"index.d.ts","exports":"./index.js","scripts":{"build":"rimraf \"*.d.ts\" && tsc && type-coverage"},"xo":false,"typeCoverage":{"atLeast":100,"detail":true,"strict":true,"ignoreCatch":true},"homepage":"https://github.com/micromark/micromark/tree/main#readme","_id":"micromark-util-encode@1.0.0-alpha.1","_nodeVersion":"16.2.0","_npmVersion":"7.15.1","dist":{"shasum":"273e52dfd4981a87b600dd3384e447ec4d27aa11","size":1877,"noattachment":false,"key":"/micromark-util-encode/-/micromark-util-encode-1.0.0-alpha.1.tgz","tarball":"http://name.csiicloud.com:7001/micromark-util-encode/download/micromark-util-encode-1.0.0-alpha.1.tgz"},"_npmUser":{"name":"wooorm","email":"tituswormer@gmail.com"},"directories":{},"maintainers":[{"name":"wooorm","email":""}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/micromark-util-encode_1.0.0-alpha.1_1623057980151_0.5888771615042674"},"_hasShrinkwrap":false,"publish_time":1623057980308,"_cnpm_publish_time":1623057980308,"_cnpmcore_publish_time":"2021-12-14T05:34:39.890Z"}},"readme":"# micromark-util-encode\n\n[![Build][build-badge]][build]\n[![Coverage][coverage-badge]][coverage]\n[![Downloads][downloads-badge]][downloads]\n[![Size][bundle-size-badge]][bundle-size]\n[![Sponsors][sponsors-badge]][opencollective]\n[![Backers][backers-badge]][opencollective]\n[![Chat][chat-badge]][chat]\n\nmicromark utility to encode dangerous html characters.\n\n## Contents\n\n*   [Install](#install)\n*   [Use](#use)\n*   [API](#api)\n    *   [`encode(value)`](#encodevalue)\n*   [Security](#security)\n*   [Contribute](#contribute)\n*   [License](#license)\n\n## Install\n\n[npm][]:\n\n```sh\nnpm install micromark-util-encode\n```\n\n## Use\n\n```js\nimport {encode} from 'micromark-util-encode'\n\nencode('<3') // '&lt;3'\n```\n\n## API\n\nThis module exports the following identifiers: `encode`.\nThere is no default export.\n\n### `encode(value)`\n\nEncode only the dangerous HTML characters.\n\nThis ensures that certain characters which have special meaning in HTML are\ndealt with.\nTechnically, we can skip `>` and `\"` in many cases, but CM includes them.\n\n###### Parameters\n\n*   `value` (`string`) — Value to encode.\n\n###### Returns\n\n`string` — Encoded value.\n\n## Security\n\nSee [`security.md`][securitymd] in [`micromark/.github`][health] for how to\nsubmit a security report.\n\n## Contribute\n\nSee [`contributing.md`][contributing] in [`micromark/.github`][health] for ways\nto get started.\nSee [`support.md`][support] for ways to get help.\n\nThis project has a [code of conduct][coc].\nBy interacting with this repository, organisation, or community you agree to\nabide by its terms.\n\n## License\n\n[MIT][license] © [Titus Wormer][author]\n\n<!-- Definitions -->\n\n[build-badge]: https://github.com/micromark/micromark/workflows/main/badge.svg\n\n[build]: https://github.com/micromark/micromark/actions\n\n[coverage-badge]: https://img.shields.io/codecov/c/github/micromark/micromark.svg\n\n[coverage]: https://codecov.io/github/micromark/micromark\n\n[downloads-badge]: https://img.shields.io/npm/dm/micromark-util-encode.svg\n\n[downloads]: https://www.npmjs.com/package/micromark-util-encode\n\n[bundle-size-badge]: https://img.shields.io/bundlephobia/minzip/micromark-util-encode.svg\n\n[bundle-size]: https://bundlephobia.com/result?p=micromark-util-encode\n\n[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg\n\n[backers-badge]: https://opencollective.com/unified/backers/badge.svg\n\n[opencollective]: https://opencollective.com/unified\n\n[npm]: https://docs.npmjs.com/cli/install\n\n[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg\n\n[chat]: https://github.com/micromark/micromark/discussions\n\n[license]: https://github.com/micromark/micromark/blob/main/license\n\n[author]: https://wooorm.com\n\n[health]: https://github.com/micromark/.github\n\n[securitymd]: https://github.com/micromark/.github/blob/HEAD/security.md\n\n[contributing]: https://github.com/micromark/.github/blob/HEAD/contributing.md\n\n[support]: https://github.com/micromark/.github/blob/HEAD/support.md\n\n[coc]: https://github.com/micromark/.github/blob/HEAD/code-of-conduct.md\n","_attachments":{},"homepage":"https://github.com/micromark/micromark/tree/main#readme","bugs":{"url":"https://github.com/micromark/micromark/issues"},"license":"MIT"}