Package Exports
- truncated-list
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (truncated-list) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
truncated-list
Create a list of items with truncating lines to the specified maximum number
const truncatedList = require('truncated-list');
console.log(truncatedList([
'Apple',
'Orange',
'Strawberry',
'Grape',
'Lemon',
'Kiwi'
], 4));
* Apple
* Orange
* Strawberry
* Grape
... and 2 more
Installation
npm install truncated-list
API
const truncatedList = require('truncated-list');
truncatedList(items, max)
items: Iterable<string>
(list items)
max: integer
(maximum number of items)
Return: string
It joins items into a list each of lines begins with *
.
If the number of items exceeds max
, it truncates the surplus and append ... and X more
to the result.
truncatedList(new Set(['a', 'b']), 2);
//=> '* a\n* b'
truncatedList(new Set(['a', 'b']), 1);
//=> '* a\n ... and 1 more'
License
ISC License © 2018 Shinnosuke Watanabe