` to truncate the returned node, or any falsy value to truncate the original node.\n\n```ts\nimport truncate, { type IOptions, type ICustomNodeStrategy } from 'truncate-html'\n\n// argument node is a cheerio instance\nconst customNodeStrategy: ICustomNodeStrategy = node => {\n // remove img tag\n if (node.is('img')) {\n return 'remove'\n }\n // keep italic tag and its children\n if (node.is('i')) {\n return 'keep'\n }\n // truncate summary tag that inside details tag instead of details tag\n if (node.is('details')) {\n return node.find('summary')\n }\n}\n\nconst html = '![](\"abc.png\")
italicboldClick me
Some details
This is a string
italicboldClick me
Some details
Th...
\n\n\n```\n\n### About final string length\n\nIf the html string content's length is shorter than `options.length`, then no ellipsis will be appended to the final html string. If longer, then the final string length will be `options.length` + `options.ellipsis`. And if you set `reserveLastWord` to true or none zero number or using `customNodeStrategy`, the final string will be various.\n\n### About html comments\n\nAll html comments `` will be removed\n\n### About dealing with none alphabetic languages\n\nWhen dealing with none alphabetic languages, such as Chinese/Japanese/Korean, they don't separate words with whitespaces, so options `byWords` and `reserveLastWord` should only works well with alphabetic languages.\n\nAnd the only dependency of this project `cheerio` has an issue when dealing with none alphabetic languages, see [Known Issues](#known-issues) for details.\n\n### Using existing cheerio instance\n\nIf you want to use existing cheerio instance, truncate option `decodeEntities` will not work, you should set it in your own cheerio instance:\n\n```js\nvar html = 'This is a string
for test.'\nconst $ = cheerio.load(`${html}`, {\n decodeEntities: true\n /** other cheerio options */\n}, false) // third parameter is for `isDocument` option, set to false to get rid of extra wrappers, see cheerio's doc for details\ntruncate($, 10)\n\n```\n\n## Examples\n\n```javascript\nvar truncate = require('truncate-html')\n\n// truncate html\nvar html = 'This is a string
for test.'\ntruncate(html, 10)\n// returns: This is a ...
\n\n// truncate string with emojis\nvar string = 'poo 💩💩💩💩💩
'\ntruncate(string, 6)\n// returns:
poo 💩💩...
\n\n// with options, remove all tags\nvar html = 'This is a string
for test.'\ntruncate(html, 10, { stripTags: true })\n// returns: This is a ...\n\n// with options, truncate by words.\n// if you try to truncate none alphabet language(like CJK)\n// it will not act as you wish\nvar html = 'This is a string
for test.'\ntruncate(html, 3, { byWords: true })\n// returns: This is a ...
\n\n// with options, keep whitespaces\nvar html = ' This is a string
for test.'\ntruncate(html, 10, { keepWhitespaces: true })\n// returns: This is a ...
\n\n// combine length and options\nvar html = 'This is a string
for test.'\ntruncate(html, {\n length: 10,\n stripTags: true\n})\n// returns: This is a ...\n\n// custom ellipsis sign\nvar html = 'This is a string
for test.'\ntruncate(html, {\n length: 10,\n ellipsis: '~'\n})\n// returns: This is a ~
\n\n// exclude some special elements(by selector), they will be removed before counting content's length\nvar html = 'This is a string
for test.'\ntruncate(html, {\n length: 10,\n ellipsis: '~',\n excludes: 'img'\n})\n// returns: This is a ~
\n\n// exclude more than one category elements\nvar html =\n 'This is a string
unwanted string inserted ( ´•̥̥̥ω•̥̥̥` ）
for test.'\ntruncate(html, {\n length: 20,\n stripTags: true,\n ellipsis: '~',\n excludes: ['img', '.something-unwanted']\n})\n// returns: This is a string for~\n\n// handing encoded characters\nvar html = ' test for <p> encoded string
'\ntruncate(html, {\n length: 20,\n decodeEntities: true\n})\n// returns: test for <p> encode...
\n\n// when set decodeEntities false\nvar html = ' test for <p> encoded string
'\ntruncate(html, {\n length: 20,\n decodeEntities: false // this is the default value\n})\n// returns: test for <p...
\n\n// and there may be a surprise by setting `decodeEntities` to true when handing CJK characters\nvar html = ' test for <p> ä¸æ–‡ string
'\ntruncate(html, {\n length: 20,\n decodeEntities: true\n})\n// returns: test for <p> 中文 str...
\n// to fix this, see below for instructions\n\n\n// custom node strategy to keep some special elements\nvar html = 'italicboldThis is a string
for test.'\ntruncate(html, {\n length: 10,\n customNodeStrategy: node => {\n if (node.is('img')) {\n return 'remove'\n }\n if (node.is('i')) {\n return 'keep'\n }\n }\n})\n// returns: italicboldThis is a ...
\n\n// custom node strategy to truncate summary instead of original node\nvar html = 'Click me
Some details
other things
Click me
Some details
ot...
![\"Github](\"https://github.com/oe/truncate-html/actions/workflows/main.yml/badge.svg\"){kind=icon}
\n \n \n ![\"code](\"https://img.shields.io/badge/%3C%2F%3E-typescript-blue\"){kind=icon}
\n \n \n ![\"npm](\"https://badge.fury.io/js/truncate-html.svg\"){kind=icon}
\n \n \n ![\"npm](\"https://img.shields.io/npm/dm/truncate-html.svg\")
\n \n \n ![\"Coverage](\"https://codecov.io/gh/oe/truncate-html/branch/main/graph/badge.svg\"){kind=icon}
\n \n![](\"xxx.jpg\")
Hello from earth!