https://github.com/glentiki/string-padder

A (tiny) node.js utility module for padding strings
https://github.com/glentiki/string-padder

Last synced: 15 days ago
JSON representation

A (tiny) node.js utility module for padding strings

• Host: GitHub
• URL: https://github.com/glentiki/string-padder
• Owner: GlenTiki
• Created: 2015-05-06T22:17:08.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-05-20T11:58:28.000Z (over 9 years ago)
• Last Synced: 2024-12-11T10:08:24.246Z (about 1 month ago)
• Language: JavaScript
• Size: 137 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# string-padder - Another string padding module.

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

*A (tiny!) utility module for string padding methods.*

I created this after seeing the code here: http://www.lm-tech.it/Blog/post/2012/12/01/String-Padding-in-Javascript.aspx

I didn't want to mess with the String prototype however... so here we are!

This is a module which (Currently) exports 3 functions, `padLeft`, `padRight` and `padBoth`. All functions take the string which is to be padded, the length the string must be padded to and optionally the string of chars or a single char to pad the string with, and returns the padded string. If no string of chars/single char is passed into the function to pad with, it defaults to a space char: ' '.

If a string is entered to be used as the pad, that string is repeated until the return string length is the pad length passed into the function, cutting the pad string off mid string. This can cause unexpected behaviour if using padBoth. Please refer to the padBoth example to see the behaviour expected. The left side pad is given precedence, but only by a single character, meaning the function will try to pad each side equally.

## Installing

```npm install string-padder```

## padLeft Example

```javascript

	var padLeft = require('string-padder').padLeft;

	// basic example of a single char used as padding

	var stringToBePadded = "hey I'm only 27 chars long!";

	var leftPaddedString = padLeft(stringToBePadded, 35, '_');

	leftPaddedString  === "________hey I'm only 27 chars long!"

	// example of repeating string padding

	var str = "123";

	var tenLong = padLeft(str, 10, "abcde");

	tenLong === "abcdeab123";

```

## padRight Example

```javascript

	var padRight = require('string-padder').padRight;

	// basic example of a single char used as padding

	var stringToBePadded = "hey I'm only 27 chars long!";

	var rightPaddedString = padRight(stringToBePadded, 35, '_');

	rightPaddedString  === "hey I'm only 27 chars long!________";

	// example of repeating string padding

	var str = "123";

	var tenLong = padRight(str, 10, 'abcde');

	tenLong === "123abcdeab";

```

## padBoth Example

```javascript

	var padBoth = require('string-padder').padBoth;

	// basic example of a single char used as padding

	var stringToBePadded = "hey I'm only 27 chars long!";

	var bothPaddedString = padBoth(stringToBePadded, 35, '_');

	bothPaddedString  === "____hey I'm only 27 chars long!____";

	var leftSidePrecedence = padBoth(stringToBePadded, 36, '_');

	leftSidePrecedence  === "_____hey I'm only 27 chars long!____";

	// example of repeating string padding

	var str = "123";

	var tenLong = padBoth(str, 10, "abcde");

	tenLong === "abcd123abc";

	var twentyLong = padBoth(str, 20, "abcde");

	twentyLong === "abcdeabcd123abcdeabc";

```

## Happy Padding!

Copyright 2015 - Glen Keane - MIT Licence