Meet npm Pro: unlimited public & private packages + package-based permissions.Learn more »

trim-words

1.2.1 • Public • Published

trim-words

NPM version Downloads Build Status AppVeyor Build Status Dependency Status

Trims text to a certain number of words.

Install

Via npm

npm install trim-words

Via Yarn

yarn add trim-words

Usage

Import Package in Node.js.

var trimWords = require('trim-words');

Import Package in React.

import trimWords from 'trim-words';

Example

Trims text to a certain number of words in Node.js.

var trimWords = require('trim-words');

var text = '<h1>What is Geostatistics?</h1> <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis tincidunt quam ut ligula ullamcorper interdum. Nulla malesuada purus tristique justo tristique, id posuere purus tristique. Pellentesque non magna ut libero elementum interdum vel vitae ante. Sed porta auctor urna eget venenatis. Mauris nec convallis metus. Sed at dui elit. Donec rhoncus justo neque, finibus commodo dui posuere ut. Maecenas in mi enim. Quisque maximus enim nunc.</p> <p>Donec eu ultricies ipsum. Fusce eget pellentesque urna. Vestibulum lacinia laoreet mi nec posuere. Duis vel elit elementum, scelerisque eros a, sodales eros. Praesent hendrerit neque velit, nec pretium ipsum finibus facilisis. Proin ultricies sem in sapien consectetur dictum.</p>';

var trimmedText = trimWords(text, 80, '...');

console.log('Trimmed Text is: ', trimmedText);

Trims text to a certain number of words in React.

import trimWords from 'trim-words';

var text = '<h1>What is Geostatistics?</h1> <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis tincidunt quam ut ligula ullamcorper interdum. Nulla malesuada purus tristique justo tristique, id posuere purus tristique. Pellentesque non magna ut libero elementum interdum vel vitae ante. Sed porta auctor urna eget venenatis. Mauris nec convallis metus. Sed at dui elit. Donec rhoncus justo neque, finibus commodo dui posuere ut. Maecenas in mi enim. Quisque maximus enim nunc.</p> <p>Donec eu ultricies ipsum. Fusce eget pellentesque urna. Vestibulum lacinia laoreet mi nec posuere. Duis vel elit elementum, scelerisque eros a, sodales eros. Praesent hendrerit neque velit, nec pretium ipsum finibus facilisis. Proin ultricies sem in sapien consectetur dictum.</p>';

var trimmedText = trimWords(text, 80, '...');

console.log('Trimmed Text is: ', trimmedText);

Parameters

Attributes Type Required Default Description
text String Yes Text to trim.
numWords Integer No 55 Number of words.
more String No &hellip; What to append if the text needs to be trimmed.

Return

Trimmed text.

Tested

This package is tested with the Node.js and React Application.

Install

npm i trim-words

DownloadsWeekly Downloads

21

Version

1.2.1

License

MIT

Unpacked Size

7.18 kB

Total Files

5

Last publish

Collaborators

  • avatar