{"id":21706349,"url":"https://github.com/samiahmedsiddiqui/trim-words","last_synced_at":"2026-04-11T19:04:00.788Z","repository":{"id":50253976,"uuid":"217370191","full_name":"samiahmedsiddiqui/trim-words","owner":"samiahmedsiddiqui","description":"Trims text to a certain number of words.","archived":false,"fork":false,"pushed_at":"2021-05-31T09:37:14.000Z","size":92,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-04-24T07:25:26.929Z","etag":null,"topics":["react","trim","trims-text","wordpress","wp-trim-words"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/trim-words","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/samiahmedsiddiqui.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-10-24T18:45:01.000Z","updated_at":"2021-05-31T09:37:17.000Z","dependencies_parsed_at":"2022-09-05T15:21:34.860Z","dependency_job_id":null,"html_url":"https://github.com/samiahmedsiddiqui/trim-words","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samiahmedsiddiqui%2Ftrim-words","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samiahmedsiddiqui%2Ftrim-words/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samiahmedsiddiqui%2Ftrim-words/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samiahmedsiddiqui%2Ftrim-words/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/samiahmedsiddiqui","download_url":"https://codeload.github.com/samiahmedsiddiqui/trim-words/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244246528,"owners_count":20422458,"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":["react","trim","trims-text","wordpress","wp-trim-words"],"created_at":"2024-11-25T22:12:32.651Z","updated_at":"2025-12-30T21:31:31.006Z","avatar_url":"https://github.com/samiahmedsiddiqui.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# trim-words\n\n[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![AppVeyor Build Status][appveyor-image]][appveyor-url] [![Dependency Status][dependency-image]][dependency-url]\n\nTrims text to a certain number of words.\n\n## Install\n\nVia `npm`\n```bash\nnpm install trim-words\n```\n\nVia Yarn\n```bash\nyarn add trim-words\n```\n\n## Usage\n\n## With CommonJS\n\n```javascript\nvar trimWords = require('trim-words').default;\n```\n\n## With React\n\n```javascript\nimport trimWords from 'trim-words';\n```\n\n## Example\n\n### Trims text to a certain number of words in `Node.js`\n\n```javascript\nconst trimWords = require('trim-words').default;\n\nconst text = `\u003ch1\u003eWhat is Geostatistics?\u003c/h1 \u003e \u003cscript\u003evar a = 1; b = 2;\u003c/script\u003e\u003cstyle\u003ep { color: red; }\u003c/style\u003e\u003cp\u003eLorem 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.\u003c/p\u003e \u003cp\u003eDonec 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.\u003c/p\u003e`;\n\nconst trimmedText = trimWords(text, 60, '...');\n\nconsole.log('Trimmed Text is: ', trimmedText);\n```\n\n### Trims text to a certain number of words in `React`\n\n```javascript\nimport trimWords from 'trim-words';\n\nconst text = `\u003ch1\u003eWhat is Geostatistics?\u003c/h1 \u003e \u003cscript\u003evar a = 1; b = 2;\u003c/script\u003e\u003cstyle\u003ep { color: red; }\u003c/style\u003e\u003cp\u003eLorem 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.\u003c/p\u003e \u003cp\u003eDonec 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.\u003c/p\u003e`;\n\nconst trimmedText = trimWords(text, 60, '...');\n\nconsole.log('Trimmed Text is: ', trimmedText);\n```\n\n## Parameters\n\n| Attributes |   Type  | Required |   Default  | Description                                       |\n|------------|:-------:|:--------:|:----------:|---------------------------------------------------|\n| text       |  String |    Yes   |            | Text to trim.                                     |\n| numWords   | Integer |    No    |    `55`    | Number of words.                                  |\n| more       |  String |    No    | `ahellip;` | What to append if the `text` needs to be trimmed. |\n\n## Return\n\nTrimmed text.\n\n## Tested\n\nThis package is tested with the `Node.js` and `React` Application.\n\n[npm-image]: https://img.shields.io/npm/v/trim-words.svg\n[npm-url]: https://www.npmjs.com/package/trim-words\n[downloads-image]: https://img.shields.io/npm/dm/trim-words.svg\n\n[travis-image]: https://img.shields.io/travis/com/samiahmedsiddiqui/trim-words.svg?label=travis-ci\n[travis-url]: https://travis-ci.com/samiahmedsiddiqui/trim-words\n\n[appveyor-url]: https://ci.appveyor.com/project/samiahmedsiddiqui/trim-words\n[appveyor-image]: https://img.shields.io/appveyor/ci/samiahmedsiddiqui/trim-words.svg?label=appveyor\n\n[dependency-image]: https://img.shields.io/david/samiahmedsiddiqui/trim-words.svg\n[dependency-url]: https://david-dm.org/samiahmedsiddiqui/trim-words\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamiahmedsiddiqui%2Ftrim-words","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsamiahmedsiddiqui%2Ftrim-words","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamiahmedsiddiqui%2Ftrim-words/lists"}