rittenhop-ghost/versions/5.94.2/node_modules/downsize
2024-09-23 19:05:38 -04:00
..
.npmignore adding local files for running this....locally 2024-09-23 19:05:38 -04:00
.travis.yml adding local files for running this....locally 2024-09-23 19:05:38 -04:00
index.js adding local files for running this....locally 2024-09-23 19:05:38 -04:00
LICENSE adding local files for running this....locally 2024-09-23 19:05:38 -04:00
package.json adding local files for running this....locally 2024-09-23 19:05:38 -04:00
README.md adding local files for running this....locally 2024-09-23 19:05:38 -04:00
test.js adding local files for running this....locally 2024-09-23 19:05:38 -04:00

Downsize

Tag-safe HTML and XML text-truncation!

npm install downsize

Usage

Word-truncation

downsize("<p>some markup here...</p>",{"words": 2});
<p>some markup</p>

Character truncation

downsize("<p>some markup here...</p>",{"characters": 6});
<p>some m</p>

Appending an ellipsis

downsize("<p>some markup here...</p>",{"characters": 6, "append": "..."});
<p>some m...</p>

Rounding to the end of the paragraph

downsize("<p>Why, hello there!</p><p>Hello again!</p>",{"characters": 6, round:true});
<p>Why, hello there!</p>

Notes

Downsize is designed to handle bad markup, and should count words and characters accurately in spite of it. But it won't hold your hand.

It does close outstanding open tags for you, but leaves erroneous close-tags for which the opening tag couldn't be found or was erroneously nested.

Testing

npm test

Maintainers

  • Christopher Giffard
  • Adam Zethraeus

Thanks also to all the contributors!