0.1.3 • Published 10 years ago

text-wrap v0.1.3

Weekly downloads
150
License
MIT
Repository
github
Last release
10 years ago

text-wrap

Fast and safe way to wrap your text with a header + footer.

Build Status Coverage Status

Reasons for using it:

  • Separate initialization for header + footer is necessary for fast file processing.
  • Customizable verification for header + footer presence to avoid their duplication.

Installing

$ npm install text-wrap

Testing

$ npm test

Testing with coverage:

$ npm run coverage

Usage

As a function, when a single instance is used:

var wrap = require('text-wrap');
wrap.header = 'header-';
wrap.footer = '-footer';
wrap('body'); //=> header-body-footer

As a class, when multiple instances are needed:

var TextWrap = require('text-wrap');
var tw = new TextWrap();
tw.header = 'header-';
tw.footer = '-footer';
tw.wrap('body'); //=> header-body-footer

For bulk file processing see grunt-file-wrap.

API

wrap(text, options) ⇒ String

Wraps the text with the current header + footer, according to the options, and returns the result.

By default, the header is added when it is not found within the text, or when there are non-empty symbols that precede it. Accordingly, the footer is added when it is not found within the text, or when there are non-empty symbols that follow it.

Before the header or footer are searched for within text, they are trimmed first - all trailing empty symbols are removed from them (spaces, tabs, line breaks). However, their full content is used when adding them.

Passing in a non-string value for the text will throw Invalid text input.

options.skipCheck ⇒ Boolean

Disables verification for duplicate header or footer.

  • false (default) - add header + footer, if they are missing
  • true - add header + footer regardless of their presence

Enabling this option is effectively switching off most of what this library does, which may be needed when processing files in a bulk requires no verification for certain file types.

options.unique ⇒ Boolean

Enforces uniqueness of both header and footer within the text.

  • false (default) - verify for non-empty symbols that precede the header or follow the footer
  • true - ignore non-empty symbols, add header + footer only when not found

Enabling this option is to ignore non-empty symbols that precede the header or follow the footer, and to add them only when they are not found within the text at all.

NOTE: This option has no effect when option skipCheck is enabled.

wrap.header ⇒ String

Header text to be added, set to an empty string by default.

Setting it to a non-string value will throw Invalid header content.

wrap.footer ⇒ String

Footer text to be added, set to an empty string by default.

Setting it to a non-string value will throw Invalid footer content.

wrap.clear()

Resets content for both header and footer to empty strings.

License

Copyright © 2016 Vitaly Tomilov; Released under the MIT license.

0.1.3

10 years ago

0.1.2

10 years ago

0.1.1

10 years ago

0.1.0

10 years ago

0.0.4

10 years ago

0.0.3

10 years ago

0.0.2

10 years ago

0.0.1

10 years ago