binhqd/str_shorten

Shorten string by character length with word boundary supported

str_shorten

Shorten string by character length with word boundary supported

NPM

Install the module with:

npm install --save str_shorten

Yarn

Install the module with:

yarn add str_shorten

Usage

str_shorten(string, maxChars, options)

Options

name	default	required	type	description
wordBoundary	true	false	boolean	Indicate whether using word boundary or not.
endSymbols	'...'	false	string	Symbols indicate there is more text.

Example

Basic

var strShorten = require("str_shorten")
var str = "We will win if we want";
var shortenStr = strShorten(str, 11);

The return value will be "We will win..."

Customize end symbols

var strShorten = require("str_shorten")
var str = "We will win if we want";
var shortenStr = strShorten(str, 11, {endSymbols: ' -->'});

The return value will be "We will win -->"

Without end symbols

var strShorten = require("str_shorten")
var str = "We will win if we want";
var shortenStr = strShorten(str, 11, {endSymbols: ''});

The return value will be "We will win"

See Demo

License

Copyright (c) 2018 Binh Quan

Licensed under the MIT license.

str_shorten's Issues

Create unit test script

Add more help to README.md

Add test with no endSymbols

Add Javis build

Remove unused file publish npm

I see many unused file in str_shorten:

• coverage
• docs
• test script, etc..

We just need index.js file(1KB) but str_shorten is big(>5.4MB).

Fix format code and add file config support editor

Need todo:

1. Format code library
2. Add some file config support editor
3. Add global define for eslint config
4. Update README: How to install package with yarn
5. Add .nvmrc file config node stable
6. Use let and arrow function for test script

Remove `dist` folder in `git`

dist-es6 and dist-module will be automatically created when you build.

It is unnecessary in git.

Add support of ending character

Create index.js for implementing code

Add istanbul coveralls

Update README for more information

Add bithound.io analytic

Add JSLint

Add badges

Add Catalog

Build dist:module

Fix `npm test` script

Build dist:es6