JSDoc: Class: String

new String()

Source:

ext/string.js, line 3

Members

(static) PADDING :String

Default value used in pad functions.

Type:

String

Source:

ext/string.js, line 85

Methods

(static) is(value) → {Boolean}

Determines whether the given value is a string.

Parameters:

Name	Type	Description
`value`	*

Source:

ext/string.js, line 15

Returns:

Type: Boolean

assign(object) → {String}

Assigns values from the object into variables in curly braces.

Parameters:

Name	Type	Description
`object`	Object

Source:

ext/string.js, line 156

Returns:

Type: String

Example

"{test} {noSuchProperty}".assign({ test: "test value" });
// this results in "test value {noSuchProperty}"

camelize(firstopt) → {String}

Parameters:

Name	Type	Attributes	Default	Description
`first`	Boolean	<optional>	true

Source:

ext/string.js, line 380

Returns:

Type: String

capitalize(allopt) → {String}

Parameters:

Name	Type	Attributes	Default	Description
`all`	Boolean	<optional>	false

Source:

ext/string.js, line 337

Returns:

Type: String

chars() → {Array.<String>}

Source:

ext/string.js, line 137

Returns:

An array of chars

Type: Array.<String>

dasherize() → {String}

Source:

ext/string.js, line 348

Returns:

Type: String

decodeHTML() → {String}

Source:

ext/string.js, line 69

Returns:

HTML-decoded value

Type: String

decodeURI(partialopt) → {String}

Parameters:

Name	Type	Attributes	Description
`partial`	Boolean	<optional>

Source:

ext/string.js, line 50

Returns:

URI-decoded value

Type: String

encodeHTML() → {String}

Source:

ext/string.js, line 56

Returns:

HTML-encoded value

Type: String

encodeURI(partialopt) → {String}

Parameters:

Name	Type	Attributes	Description
`partial`	Boolean	<optional>

Source:

ext/string.js, line 43

Returns:

URI-encoded value

Type: String

endsWith(substr, indexopt) → {String}

Parameters:

Name	Type	Attributes	Default	Description
`substr`	String
`index`	Number	<optional>	this.length

Source:

ext/string.js, line 240

Returns:

Type: String

normalizeLines() → {String}

Replaces both \r\n & \r by just \n.

Source:

ext/string.js, line 167

Returns:

Type: String

pad(length, padStringopt) → {String}

Parameters:

Name	Type	Attributes	Default	Description
`length`	Number
`padString`	String	<optional>	" "

Source:

ext/string.js, line 129

Returns:

Type: String

padLeft(length, padStringopt) → {String}

Parameters:

Name	Type	Attributes	Default	Description
`length`	Number
`padString`	String	<optional>	" "

Source:

ext/string.js, line 93

Returns:

Type: String

padRight(length, padStringopt) → {String}

Parameters:

Name	Type	Attributes	Default	Description
`length`	Number
`padString`	String	<optional>	" "

Source:

ext/string.js, line 111

Returns:

Type: String

parametrize(separatoropt) → {String}

Creates an URI-safe identifier from the string.

Parameters:

Name	Type	Attributes	Default	Description
`separator`	String	<optional>	"-"

Source:

ext/string.js, line 403

Returns:

Type: String

removeDiacritics() → {String}

Source:

ext/string.js, line 326

Returns:

Type: String

repeat(times) → {String}

Parameters:

Name	Type	Description
`times`	Number

Source:

ext/string.js, line 258

Throws:

RangeError

Returns:

Type: String

repeatUntil(length) → {String}

Parameters:

Name	Type	Description
`length`	Number

Source:

ext/string.js, line 277

Throws:

RangeError

Returns:

Type: String

replaceAll(substr, newSubstr) → {String}

Parameters:

Name	Type	Description
`substr`	String
`newSubstr`	String

Source:

ext/string.js, line 23

Returns:

Type: String

reverse() → {String}

Source:

ext/string.js, line 143

Returns:

Type: String

spacify() → {String}

Source:

ext/string.js, line 371

Returns:

Type: String

startsWith(substr, indexopt) → {String}

Parameters:

Name	Type	Attributes	Default	Description
`substr`	String
`index`	Number	<optional>	0

Source:

ext/string.js, line 225

Returns:

Type: String

substr(indexopt, lengthopt) → {String}

Supports negative index.

Parameters:

Name	Type	Attributes	Default	Description
`index`	Number	<optional>	0
`length`	Number	<optional>

Source:

ext/string.js, line 310

Returns:

Type: String

toFloat() → {Number}

Source:

ext/string.js, line 36

Returns:

Type: Number

toInt(radixopt) → {Number}

Parameters:

Name	Type	Attributes	Default	Description
`radix`	Number	<optional>	10

Source:

ext/string.js, line 30

Returns:

Type: Number

trim(substr, indexopt) → {String}

Parameters:

Name	Type	Attributes	Default	Description
`substr`	String
`index`	Number	<optional>	0

Source:

ext/string.js, line 214

Returns:

Type: String

trim() → {String}

Source:

ext/string.js, line 180

Returns:

Type: String

trimLeft() → {String}

Source:

ext/string.js, line 191

Returns:

Type: String

trimRight() → {String}

Source:

ext/string.js, line 202

Returns:

Type: String

underscore() → {String}

Source:

ext/string.js, line 363

Returns:

Type: String