https://github.com/reyiyo/node-wordwrap2

Wrap your words in node.js
https://github.com/reyiyo/node-wordwrap2

column cut format rule word wordwrap wrap

Last synced: 11 days ago
JSON representation

Wrap your words in node.js

• Host: GitHub
• URL: https://github.com/reyiyo/node-wordwrap2
• Owner: reyiyo
• License: other
• Created: 2017-07-04T19:18:37.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-07-04T19:37:54.000Z (over 7 years ago)
• Last Synced: 2024-09-18T20:47:17.043Z (2 months ago)
• Topics: column, cut, format, rule, word, wordwrap, wrap
• Language: JavaScript
• Size: 31.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.markdown
  • License: LICENSE

Awesome Lists containing this project

README

        
wordwrap

========

Wrap your words.

This repo is a copy from the excellent lib by @substack at https://github.com/substack/node-wordwrap. This new repo has some bugfixes and PRs merged and is released as a new module on npm as the original one seems unmaintained.

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", lengthFn: String.length})

----------------------------------------------------------------------------

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`.

If provided, a custom length function can be used in place of the default `String.length`.

wrap.hard(start, stop)

----------------------

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