1.0.0 • Published 9 years ago

string-tools v1.0.0

Weekly downloads
2,288
License
MIT
Repository
github
Last release
9 years ago

view on npm npm module downloads per month Build Status Dependency Status

string-tools

Example

var s = require("string-tools");

s.symbol

some cross platform symbols (tick and cross)

Kind: static property of string-tools

s.escapeRegExp()

escape special regular expression characters

Kind: static method of string-tools
Example

> s.escapeRegExp("(.*)");
'\\(\\.\\*\\)'

s.fill(fillWith, len) ⇒ string

Create a new string filled with the supplied character

Kind: static method of string-tools

ParamTypeDescription
fillWithstringthe fill character
lennumberthe length of the output string

Example

> s.fill("a", 10)
'aaaaaaaaaa'
> s.fill("ab", 10)
'aaaaaaaaaa'

s.padRight(input, width, padWith) ⇒ string

Add padding to the right of a string

Kind: static method of string-tools

ParamTypeDefaultDescription
inputstringthe string to pad
widthnumberthe desired final width
padWithstring"\" \""the padding character

Example

> s.padRight("clive", 1)
'clive'
> s.padRight("clive", 1, "-")
'clive'
> s.padRight("clive", 10, "-")
'clive-----'

s.repeat(input, times) ⇒ string

returns the input string repeated the specified number of times

Kind: static method of string-tools

ParamTypeDescription
inputstringinput string to repeat
timesnumberthe number of times to repeat

s.clipLeft(input, width, prefix) ⇒ string

returns the input string clipped from the left side in order to meet the specified width

Kind: static method of string-tools

ParamTypeDefaultDescription
inputstringinput string to repeat
widthnumberthe desired final width
prefixstring"..."the prefix to replace the clipped region

© 2015 Lloyd Brookes \75pound@gmail.com\. Documented by jsdoc-to-markdown.