Skip to content

Trims strings to a maximum length and appends dot dot dot if needed.

License

Notifications You must be signed in to change notification settings

Jaid/crop-string

Repository files navigation

crop-string

License Sponsor crop-string
Build status Commits since v2.0.1 Last commit Issues
Latest version on npm Dependents Downloads

Trims strings to a maximum length and appends dot dot dot if needed.

Installation

crop-string on npm

npm install --save crop-string@^2.0.1

crop-string on Yarn

yarn add crop-string@^2.0.1

@jaid/crop-string on GitHub Packages
(if configured properly)

npm install --save @jaid/crop-string@^2.0.1

Example

import cropString from "crop-string"

const string = "hello world"
const result = cropString(string, 4)

Variable result will now be:

"hel…"

Development

Setting up:

git clone git@github.com:jaid/crop-string.git
cd crop-string
npm install

Testing:

npm run test:dev

Testing in production environment:

npm run test

License

MIT License

Copyright © 2020, Jaid <jaid.jsx@gmail.com> (github.com/jaid)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.