https://github.com/component/truncate

Truncate string
https://github.com/component/truncate

Last synced: 13 days ago
JSON representation

Truncate string

• Host: GitHub
• URL: https://github.com/component/truncate
• Owner: component
• Created: 2012-10-04T21:46:07.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2014-02-25T22:45:56.000Z (almost 11 years ago)
• Last Synced: 2024-12-12T01:47:40.842Z (17 days ago)
• Language: JavaScript
• Size: 188 KB
• Stars: 11
• Watchers: 5
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • Changelog: History.md

Awesome Lists containing this project

README

        

# Truncate

  String truncation utility…

## Installation

```

$ npm install truncate

$ component install component/truncate

```

## API

### truncate(str, chars)

```js

var truncate = require('truncate');

truncate('Hello world there', 15); // 'Hello world'

```

### truncate(str, chars, suffix)

```js

var truncate = require('truncate');

truncate('Hello world there', 15, ' ...'); // 'Hello world ...'

```

### truncate.left(str)

```js

var truncate = require('truncate');

truncate.left('Hello world there', 15); // Equivalent to truncate() 'Hello world'

```

### truncate.right(str, chars)

```js

var truncate = require('truncate');

truncate.right('Hello world there', 15); // 'world there'

```

### truncate.right(str, chars, prefix)

```js

var truncate = require('truncate');

truncate.right('Hello world there', 15, '... '); // '... world there'

```

## Tests

Download testing dependecies

```

npm install

```

Run tests

```

make test

```

## License

(The MIT License)

Copyright(c) 2012 Damian Suarez <[email protected]>

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.