description v0.0.4

Description

Get the description from the content of post / article / anything. Work with: string, HTML, markdown

Install

npm install description

Usage

parameters

description({ content, limit, endWith, by })

const description = require('description')

let post = require('../data/post')
post.description = description({ content: post.content, limit: 250, endWith: '[...]' })

/*
Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It [...]
*/

// or
post.description = description({ content: post.content, limit: 5, endWith: '[...]', by: 'word' })

/*
Lorem Ipsum is simply dummy [...]
*/

License

MIT