0b10 / sir-helpalot

A collection of Javascript helpers

sir-helpalot

A collection of Javascript helpers. Tested on Node.

Text

pad({ length?: number, prefix?: string, text?: string }): string

Get padding text, of a repeating pattern, and a given length.

Args

name	purpose	type	constraints	default
length	The exact returned string length	integer	0 < n < 25,000,000	1
prefix	Text to append padding to	string	non-empty: ASCII, UTF-8, and UTF-16. Must not be a surrogate pair. Must be shorter than "length".	""
text	The repeating text pattern	string	non-empty: ASCII, UTF-8, and UTF-16. Must not be a surrogate pair.	"#"

Throws

SirHelpalotError: When text isn't a valid string, or length isn't a valid integer.

Examples

const { pad } = require("sir-helpalot/text");

pad({ length: 4, text: "ab" }); // => "abab"
pad({ length: 4, text: "a " }); // => "a a "
pad({ length: 16, text: " pad", prefix: "prefix" }); // => "prefix pad pad p"
pad(); // with defaults: => "#"

---