https://github.com/juliannicholls/npm-justify-text
justify-text npm module
https://github.com/juliannicholls/npm-justify-text
justify npm-module npm-package text
Last synced: 2 months ago
JSON representation
justify-text npm module
- Host: GitHub
- URL: https://github.com/juliannicholls/npm-justify-text
- Owner: JulianNicholls
- License: mit
- Created: 2017-10-24T20:02:41.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-06-13T06:18:22.000Z (about 1 year ago)
- Last Synced: 2025-03-15T16:04:34.451Z (3 months ago)
- Topics: justify, npm-module, npm-package, text
- Language: JavaScript
- Size: 343 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# justify-text
This is a simple module, which allows for left or right justifying text
in a given width. The padding character can be specified, and it defaults
to a space.
Numbers are explicily handled now, so they do not need to be converted to
a string before passing them to `ljust` or `rjust` any more.
If the padding width specified is less than the length of the initial string,
no truncation occurs.
## Installation
```
npm install -S justify-text
```
or
```
yarn add justify-text
```
## Functions
`ljust()` and `rjust()` take a string or number, a width to render it in,
and an optional padding character, which is a space by default.
``` js
ljust(string, width, padding=' ')
rjust(string, width, padding=' ')
```
### Usage
``` js
const { ljust, rjust } = require('justify-text');
ljust('text', 7);
// => "text "
ljust('text', 6, '0');
// => "text00"
rjust('text', 8);
// => " text"
rjust('longtext', 7);
// => "longtext", i.e. unchanged because it is already more than 7 characters
rjust('text', 9, '.');
// => ".....text"
rjust(936, 5);
// => " 936"
ljust(780.25, 8);
// => "780.25 "
```
## License
MIT