node package manager


Left and right string padding

Node Pad is a simple function to pad strings in both left and right directions.

pad('pad', 5) # "pad  "
pad(5, 'pad') # "  pad"
pad('pad', 5, '+') # "pad++"
pad(5, 'pad', '+') # "++pad"

Left padding occurs when the first argument is a number and the second argument is a string.

var pad = require('pad');
pad(5, 'pad', '-').should.eql('-pad');

Right padding occurs when the first argument is a string and the second argument is a number.

var pad = require('pad');
pad('pad', 6).should.eql('pad   ');

Options are provided as a third argument and are all optional. A string argument it is interpreted as the "char" option. Accepted options include:

  • char (string)
    The character used to fill the gap.
  • colors (boolean)
    Ajust to hidden terminal color characters, you may also use require 'pad/lib/colors' to avoid passing this option.
  • strip (boolean)
    Remove characters from text if length smaller than text length, default to "false".

Via npm:

npm install pad

Via git (or downloaded tarball), copy or link the project from a discoverable Node directory:

git clone

Clone the repo, install the development dependencies and run the suite:

git clone .
npm install
make test