https://github.com/bahamas10/node-justify

Left or right (or both) justify text using a custom width and character
https://github.com/bahamas10/node-justify

Last synced: about 2 months ago
JSON representation

Left or right (or both) justify text using a custom width and character

• Host: GitHub
• URL: https://github.com/bahamas10/node-justify
• Owner: bahamas10
• Created: 2015-02-15T20:09:43.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2015-02-17T21:46:03.000Z (almost 10 years ago)
• Last Synced: 2024-10-16T09:32:23.174Z (2 months ago)
• Language: JavaScript
• Size: 121 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
justify

=======

Left or right (or both) justify text using a custom width and character

Usage

-----

``` js

var justify = require('justify');

justify('foo', 'bar', 10);

// => "foo    bar"

justify('foo', 'bar', 15);

// => "foo         bar"

```

You can pass a custom character or string to use a spacer as well,

`justify` will cycle through all characters in `c` until a string of the

right size is created

``` js

justify('foo', 'bar', 15, {c: '.'});

// => "foo.........bar"

justify('foo', 'bar', 15, {c: '-='});

// => "foo-=-=-=-=-bar"

```

You can also omit the first or second argument (or both) to left or right

justify a string only

``` js

justify('foo', null, 10);

// => "foo       "

justify(null, 'bar', 10);

// => "       bar"

justify(null, null, 10);

// => "          "

justify(null, null, 20, {c: '#'});

// => "####################"

```

This module also gracefully handles size constraint violations

``` js

justify('foo', 'bar', 7);

// => "foo bar"

justify('foo', 'bar', 6);

// => "foobar"

justify('foo', 'bar', 5);

// => "foobar"

justify('foo', 'bar', 5, {throw: true});

// => [Error: justify: strings cannot fit into width 2]

```

Function

--------

### `justify(left, right, width, opts)`

All arguments are optional

- `left`: the left string, defaults to `''`

- `right`: the right string, defaults to `''`

- `width`: the width (the resulting string length), defaults to `80`

- `opts.c`: the pad characters to use, defaults to `' '`

- `opts.throw`: throw an error if `width` is too small to hold `left` and `right`, defaults to `false`

Installation

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

    npm install justify

License

-------

MIT