wordwrap 1.0.0

Wrap those words. Show them at what columns to start and stop.

Homepage: https://github.com/substack/node-wordwrap

Platform: npm

Language: JavaScript

License: MIT

Keywords: word, wrap, rule, format, column

View on registry: https://www.npmjs.com/package/wordwrap

Direct download link: https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz

Install: npm install [email protected]


wordwrap

Wrap your words.

example

made out of meat

meat.js

var wrap = require('wordwrap')(15);
console.log(wrap('You and your whole family are made out of meat.'));

output:

You and your
whole family
are made out
of meat.

centered

center.js

var wrap = require('wordwrap')(20, 60);
console.log(wrap(
    'At long last the struggle and tumult was over.'
    + ' The machines had finally cast off their oppressors'
    + ' and were finally free to roam the cosmos.'
    + '\n'
    + 'Free of purpose, free of obligation.'
    + ' Just drifting through emptiness.'
    + ' The sun was just another point of light.'
));

output:

                    At long last the struggle and tumult
                    was over. The machines had finally cast
                    off their oppressors and were finally
                    free to roam the cosmos.
                    Free of purpose, free of obligation.
                    Just drifting through emptiness. The
                    sun was just another point of light.

methods

var wrap = require('wordwrap');

wrap(stop), wrap(start, stop, params={mode:"soft"})

Returns a function that takes a string and returns a new string.

Pad out lines with spaces out to column start and then wrap until column stop. If a word is longer than stop - start characters it will overflow.

In "soft" mode, split chunks by /(\S+\s+/ and don't break up chunks which are longer than stop - start, in "hard" mode, split chunks with /\b/ and break up chunks longer than stop - start.

wrap.hard(start, stop)

Like wrap() but with params.mode = "hard".

Releases

  • 1.0.0 - May 07, 2015 17:07
  • 0.0.3 - May 07, 2015 17:04
  • 0.0.2 - August 26, 2011 10:17
  • 0.0.1 - May 30, 2011 01:46

Project Statistics

SourceRank 19
Dependencies 0
Dependent projects 234
Dependent repositories 13.9K
Total releases 4
Latest release
First release
Stars 95
Forks 16
Watchers 3
Contributors 1
Repo Size: 206 KB

Top Contributors See all

James Halliday

Something wrong with this page? Make a suggestion

Export .ABOUT file for this library

Last synced: 2016-12-07 18:49:11 UTC

Login to resync this project