limit-characters v1.0.3

limit-characters

Limits the length of a given text with different options. Types included.

Install

npm

npm i limit-characters

Yarn

yarn add limit-characters

Usage

CommonJS

var limitCharacters = require("limit-characters")

ES6

import limitCharacters from "limit-characters"

Example

import limitCharacters from "limit-characters";

const originalText = "This library helps limit the characters of a given text"

const excerpt = limitCharacters({ text: originalText, length: 20 })
// Returns "This library help..."

const excerpt2 = limitCharacters({ text: originalText, length: 20, breakWord: false })
// Returns "This library..."

const excerpt3 = limitCharacters({ text: originalText, length: 32, breakWord: false, more: "... read more" })
// Returns "This library helps... read more"

Options