format a string into a hanging indent with Node.js
JavaScript
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
test
.gitignore
.travis.yml
index.js
license
logo.png
package.json
readme.md

readme.md

hanging-indent

Build Status Coverage Status

About | Installation | API | License

About

Turn this

Viral polaroid cronut etsy photo booth, tousled next level literally. Put a bird on it narwhal irony four dollar toast ugh, typewriter poutine austin VHS fashion axe. Wolf butcher humblebrag, roof party chillwave chambray actually typewriter hella messenger bag poutine green juice bitters meggings. Chicharrones irony plaid marfa hammock crucifix. Semiotics seitan fanny pack, biodiesel fingerstache humblebrag twee. Actually gastropub tousled cornhole, readymade mixtape vice yuccie skateboard williamsburg cred chillwave squid art party 90's. Occupy ramps before they sold out, ennui trust fund tacos flannel.

Into this

Viral polaroid cronut etsy photo booth, tousled next level literally. Put a
    bird on it narwhal irony four dollar toast ugh, typewriter poutine austin
    VHS fashion axe. Wolf butcher humblebrag, roof party chillwave chambray
    actually typewriter hella messenger bag poutine green juice bitters
    meggings. Chicharrones irony plaid marfa hammock crucifix. Semiotics seitan
    fanny pack, biodiesel fingerstache humblebrag twee. Actually gastropub
    tousled cornhole, readymade mixtape vice yuccie skateboard williamsburg
    cred chillwave squid art party 90's. Occupy ramps before they sold out,
    ennui trust fund tacos flannel.

Sample text courtesy hipster ipsum :neckbeard:

Installation

Install from terminal

$ npm install hanging-indent

Require in file

var hangingIndent = require('hanging-indent')

API

hangingIndent(line, indent, limit)

Params

  • line: line to break into a hanging-indented paragraph
    • type: string
    • required: yes
  • indent: amount of spaces to indent lines
    • type: number
    • required: no
    • default: 4
  • limit: max number of characters that can be in a line
    • type: number
    • required: no
    • default: 80

Returns

formatted string with spaces and newlines inserted

License

MIT