string

String tools.

Copyright:

Mat. 2018-present

License:

Apache-2.0

Source:

string/consts.ts, line 1

Methods

(inner) asciiLetters() → {String}

Return full set of ASCII letters.

Source:

string/consts.ts, line 12

Returns:

Type:: String

(inner) asciiLowercase() → {String}

Return lowercase ASCII letters.

Source:

string/consts.ts, line 24

Returns:

Type:: String

(inner) asciiUppercase() → {String}

Return uppercase ASCII letters.

Source:

string/consts.ts, line 35

Returns:

Type:: String

(inner) big(n, copt) → {String}

Allocate a big string (of size 2^n). Use with caution!

big(16) makes 2^16 = 65536 string size.
big(23) makes 2^23 = 8M string size,
big(24) makes 16M and so on.

c = "x" - Character used during string generation.

Example:

big(2) === "xxxx"
big(3, "a") === "aaaaaaaa"

Source:

string/gen.ts, line 17

Parameters:

Name	Type	Attributes	Default	Description
`n`
`c`		<optional>	"x"

Returns:

Type:: String

(inner) camelToPascal(str) → {String}

Convert thisKindOfText to ThisKindOfText.

Source:

string/transform.js, line 16

Parameters:

Name	Type	Description
`str`	`String`

Returns:

Type:: String

(inner) camelToSnake(str) → {String}

Convert thisKindOfText to this_kind_of_text.

Source:

string/transform.js, line 31

Parameters:

Name	Type	Description
`str`	`String`

Returns:

Type:: String

(inner) capitalize(str) → {String}

Ensure given string is in form Aaaaaaaa.

Source:

string/transform.js, line 46

Parameters:

Name	Type	Description
`str`	`String`

Returns:

Type:: String

(inner) digits() → {String}

Return all digits.

Source:

string/consts.ts, line 46

Returns:

Type:: String

(inner) ellipsis(str, placingopt, sepopt) → {String}

Constructs new string with inserted sep (of default value …) at the ellipsis.BEGIN, ellipsis.MIDDLE or ellipsis.END. Returned string has the same length as input string (thus some original characters are replaced with sep contents).

Source:

string/transform.js, line 77

Parameters:

Name	Type	Attributes	Default	Description
`str`	`String`			Text to insert `sep` (`…`) into.
`placing`	`Number`	<optional>	ellipsis.MIDDLE	Place to insert. Can be `ellipsis.BEGIN`, `ellipsis.MIDDLE` or `ellipsis.END`.
`sep`	`String`	<optional>	"…"	Separator.

Returns:

Type:: String

(inner) empty() → {String}

Construct empty string.

Source:

string/consts.ts, line 57

Returns:

Type:: String

(inner) nl() → {String}

Construct newline.

Source:

string/consts.ts, line 79

Returns:

Type:: String

(inner) padLeft(input, len, spaceopt) → {String}

Prepend given input string with an appropriate amount of ch characters so that returning string length is equal to len. If len is smaller than length of input then input is being returned untouched (padding doesn't shorten the input).

Source:

string/transform.js, line 111

Parameters:

Name	Type	Attributes	Default
`input`	`String`
`len`	`Number`
`space`	`String`	<optional>	" "

Returns:

Type:: String

(inner) padRight(input, len, spaceopt) → {String}

Append an appropriate amount of ch characters to the given input string so that returning string length is equal to len. If len is smaller than length of input then input is being returned untouched (padding doesn't shorten the input).

Source:

string/transform.js, line 130

Parameters:

Name	Type	Attributes	Default
`input`	`String`
`len`	`Number`
`space`	`String`	<optional>	" "

Returns:

Type:: String

(inner) pascalToCamel(str) → {String}

Convert ThisKindOfText to thisKindOfText.

Source:

string/transform.js, line 149

Parameters:

Name	Type	Description
`str`	`String`

Returns:

Type:: String

(inner) pascalToSnake(str) → {String}

Convert ThisKindOfText to this_kind_of_text.

Source:

string/transform.js, line 164

Parameters:

Name	Type	Description
`str`	`String`

Returns:

Type:: String

(inner) quote(stropt, qopt) → {String}

Quote text.

Source:

string/transform.js, line 177

Parameters:

Name	Type	Attributes	Default	Description
`str`	`String`	<optional>	empty()
`q`	`String`	<optional>	"\"\""

Returns:

Type:: String

(inner) random(sizeopt, lettersopt) → {String}

Construct random string of desired length.

Source:

string/gen.ts, line 48

Parameters:

Name	Type	Attributes	Default	Description
`size`		<optional>	0
`letters`		<optional>	asciiLetters()+digits()

Returns:

Type:: String

(inner) shorten(str, lenopt, placingopt, sepopt) → {String}

Constructs new string not longer than len.

Source:

string/transform.js, line 191

Parameters:

Name	Type	Attributes	Default	Description
`str`	`String`			Text to be shortened.
`len`	`Number`	<optional>	Infinity	Desired text length.
`placing`	`Number`	<optional>	shorten.MIDDLE	Character cutting place. Can be `shorten.BEGIN`, `shorten.MIDDLE` or `shorten.END`.
`sep`	`String`	<optional>	"…"	Separator.

Returns:

Type:: String

(inner) snakeToCamel(str) → {String}

Convert this_kind_of_text to thisKindOfText.

Source:

string/transform.js, line 221

Parameters:

Name	Type	Description
`str`	`String`

Returns:

Type:: String

(inner) snakeToPascal(str) → {String}

Convert this_kind_of_text to ThisKindOfText.

Source:

string/transform.js, line 238

Parameters:

Name	Type	Description
`str`	`String`

Returns:

Type:: String

(inner) space() → {String}

Construct space.

Source:

string/consts.ts, line 68

Returns:

Type:: String

(inner) tab() → {String}

Construct tab.

Source:

string/consts.ts, line 90

Returns:

Type:: String

(inner) wrap(stropt, prefixopt, suffixopt) → {String}

Wrap passed string with prefix and suffix.

Source:

string/transform.js, line 253

Parameters:

Name	Type	Attributes	Default
`str`	`String`	<optional>	empty()
`prefix`	`String`	<optional>	empty()
`suffix`	`String`	<optional>	empty()

Returns:

Type:: String

String tools.

Copyright:

Mat. 2018-present

License:

Apache-2.0

Source:

string/gen.ts, line 1

Methods

(inner) asciiLetters() → {String}

Return full set of ASCII letters.

Source:

string/consts.ts, line 12

Returns:

Type:: String

(inner) asciiLowercase() → {String}

Return lowercase ASCII letters.

Source:

string/consts.ts, line 24

Returns:

Type:: String

(inner) asciiUppercase() → {String}

Return uppercase ASCII letters.

Source:

string/consts.ts, line 35

Returns:

Type:: String

(inner) big(n, copt) → {String}

Allocate a big string (of size 2^n). Use with caution!

big(16) makes 2^16 = 65536 string size.
big(23) makes 2^23 = 8M string size,
big(24) makes 16M and so on.

c = "x" - Character used during string generation.

Example:

big(2) === "xxxx"
big(3, "a") === "aaaaaaaa"

Source:

string/gen.ts, line 17

Parameters:

Name	Type	Attributes	Default	Description
`n`
`c`		<optional>	"x"

Returns:

Type:: String

(inner) camelToPascal(str) → {String}

Convert thisKindOfText to ThisKindOfText.

Source:

string/transform.js, line 16

Parameters:

Name	Type	Description
`str`	`String`

Returns:

Type:: String

(inner) camelToSnake(str) → {String}

Convert thisKindOfText to this_kind_of_text.

Source:

string/transform.js, line 31

Parameters:

Name	Type	Description
`str`	`String`

Returns:

Type:: String

(inner) capitalize(str) → {String}

Ensure given string is in form Aaaaaaaa.

Source:

string/transform.js, line 46

Parameters:

Name	Type	Description
`str`	`String`

Returns:

Type:: String

(inner) digits() → {String}

Return all digits.

Source:

string/consts.ts, line 46

Returns:

Type:: String

(inner) ellipsis(str, placingopt, sepopt) → {String}

Source:

string/transform.js, line 77

Parameters:

Name	Type	Attributes	Default	Description
`str`	`String`			Text to insert `sep` (`…`) into.
`placing`	`Number`	<optional>	ellipsis.MIDDLE	Place to insert. Can be `ellipsis.BEGIN`, `ellipsis.MIDDLE` or `ellipsis.END`.
`sep`	`String`	<optional>	"…"	Separator.

Returns:

Type:: String

(inner) empty() → {String}

Construct empty string.

Source:

string/consts.ts, line 57

Returns:

Type:: String

(inner) nl() → {String}

Construct newline.

Source:

string/consts.ts, line 79

Returns:

Type:: String

(inner) padLeft(input, len, spaceopt) → {String}

Source:

string/transform.js, line 111

Parameters:

Name	Type	Attributes	Default
`input`	`String`
`len`	`Number`
`space`	`String`	<optional>	" "

Returns:

Type:: String

(inner) padRight(input, len, spaceopt) → {String}

Source:

string/transform.js, line 130

Parameters:

Name	Type	Attributes	Default
`input`	`String`
`len`	`Number`
`space`	`String`	<optional>	" "

Returns:

Type:: String

(inner) pascalToCamel(str) → {String}

Convert ThisKindOfText to thisKindOfText.

Source:

string/transform.js, line 149

Parameters:

Name	Type	Description
`str`	`String`

Returns:

Type:: String

(inner) pascalToSnake(str) → {String}

Convert ThisKindOfText to this_kind_of_text.

Source:

string/transform.js, line 164

Parameters:

Name	Type	Description
`str`	`String`

Returns:

Type:: String

(inner) quote(stropt, qopt) → {String}

Quote text.

Source:

string/transform.js, line 177

Parameters:

Name	Type	Attributes	Default	Description
`str`	`String`	<optional>	empty()
`q`	`String`	<optional>	"\"\""

Returns:

Type:: String

(inner) random(sizeopt, lettersopt) → {String}

Construct random string of desired length.

Source:

string/gen.ts, line 48

Parameters:

Name	Type	Attributes	Default	Description
`size`		<optional>	0
`letters`		<optional>	asciiLetters()+digits()

Returns:

Type:: String

(inner) shorten(str, lenopt, placingopt, sepopt) → {String}

Constructs new string not longer than len.

Source:

string/transform.js, line 191

Parameters:

Name	Type	Attributes	Default	Description
`str`	`String`			Text to be shortened.
`len`	`Number`	<optional>	Infinity	Desired text length.
`placing`	`Number`	<optional>	shorten.MIDDLE	Character cutting place. Can be `shorten.BEGIN`, `shorten.MIDDLE` or `shorten.END`.
`sep`	`String`	<optional>	"…"	Separator.

Returns:

Type:: String

(inner) snakeToCamel(str) → {String}

Convert this_kind_of_text to thisKindOfText.

Source:

string/transform.js, line 221

Parameters:

Name	Type	Description
`str`	`String`

Returns:

Type:: String

(inner) snakeToPascal(str) → {String}

Convert this_kind_of_text to ThisKindOfText.

Source:

string/transform.js, line 238

Parameters:

Name	Type	Description
`str`	`String`

Returns:

Type:: String

(inner) space() → {String}

Construct space.

Source:

string/consts.ts, line 68

Returns:

Type:: String

(inner) tab() → {String}

Construct tab.

Source:

string/consts.ts, line 90

Returns:

Type:: String

(inner) wrap(stropt, prefixopt, suffixopt) → {String}

Wrap passed string with prefix and suffix.

Source:

string/transform.js, line 253

Parameters:

Name	Type	Attributes	Default
`str`	`String`	<optional>	empty()
`prefix`	`String`	<optional>	empty()
`suffix`	`String`	<optional>	empty()

Returns:

Type:: String

String tools.

Copyright:

Mat. 2018-present

License:

Apache-2.0

Source:

string/transform.js, line 1

Methods

(inner) asciiLetters() → {String}

Return full set of ASCII letters.

Source:

string/consts.ts, line 12

Returns:

Type:: String

(inner) asciiLowercase() → {String}

Return lowercase ASCII letters.

Source:

string/consts.ts, line 24

Returns:

Type:: String

(inner) asciiUppercase() → {String}

Return uppercase ASCII letters.

Source:

string/consts.ts, line 35

Returns:

Type:: String

(inner) big(n, copt) → {String}

Allocate a big string (of size 2^n). Use with caution!

big(16) makes 2^16 = 65536 string size.
big(23) makes 2^23 = 8M string size,
big(24) makes 16M and so on.

c = "x" - Character used during string generation.

Example:

big(2) === "xxxx"
big(3, "a") === "aaaaaaaa"

Source:

string/gen.ts, line 17

Parameters:

Name	Type	Attributes	Default	Description
`n`
`c`		<optional>	"x"

Returns:

Type:: String

(inner) camelToPascal(str) → {String}

Convert thisKindOfText to ThisKindOfText.

Source:

string/transform.js, line 16

Parameters:

Name	Type	Description
`str`	`String`

Returns:

Type:: String

(inner) camelToSnake(str) → {String}

Convert thisKindOfText to this_kind_of_text.

Source:

string/transform.js, line 31

Parameters:

Name	Type	Description
`str`	`String`

Returns:

Type:: String

(inner) capitalize(str) → {String}

Ensure given string is in form Aaaaaaaa.

Source:

string/transform.js, line 46

Parameters:

Name	Type	Description
`str`	`String`

Returns:

Type:: String

(inner) digits() → {String}

Return all digits.

Source:

string/consts.ts, line 46

Returns:

Type:: String

(inner) ellipsis(str, placingopt, sepopt) → {String}

Source:

string/transform.js, line 77

Parameters:

Name	Type	Attributes	Default	Description
`str`	`String`			Text to insert `sep` (`…`) into.
`placing`	`Number`	<optional>	ellipsis.MIDDLE	Place to insert. Can be `ellipsis.BEGIN`, `ellipsis.MIDDLE` or `ellipsis.END`.
`sep`	`String`	<optional>	"…"	Separator.

Returns:

Type:: String

(inner) empty() → {String}

Construct empty string.

Source:

string/consts.ts, line 57

Returns:

Type:: String

(inner) nl() → {String}

Construct newline.

Source:

string/consts.ts, line 79

Returns:

Type:: String

(inner) padLeft(input, len, spaceopt) → {String}

Source:

string/transform.js, line 111

Parameters:

Name	Type	Attributes	Default
`input`	`String`
`len`	`Number`
`space`	`String`	<optional>	" "

Returns:

Type:: String

(inner) padRight(input, len, spaceopt) → {String}

Source:

string/transform.js, line 130

Parameters:

Name	Type	Attributes	Default
`input`	`String`
`len`	`Number`
`space`	`String`	<optional>	" "

Returns:

Type:: String

(inner) pascalToCamel(str) → {String}

Convert ThisKindOfText to thisKindOfText.

Source:

string/transform.js, line 149

Parameters:

Name	Type	Description
`str`	`String`

Returns:

Type:: String

(inner) pascalToSnake(str) → {String}

Convert ThisKindOfText to this_kind_of_text.

Source:

string/transform.js, line 164

Parameters:

Name	Type	Description
`str`	`String`

Returns:

Type:: String

(inner) quote(stropt, qopt) → {String}

Quote text.

Source:

string/transform.js, line 177

Parameters:

Name	Type	Attributes	Default	Description
`str`	`String`	<optional>	empty()
`q`	`String`	<optional>	"\"\""

Returns:

Type:: String

(inner) random(sizeopt, lettersopt) → {String}

Construct random string of desired length.

Source:

string/gen.ts, line 48

Parameters:

Name	Type	Attributes	Default	Description
`size`		<optional>	0
`letters`		<optional>	asciiLetters()+digits()

Returns:

Type:: String

(inner) shorten(str, lenopt, placingopt, sepopt) → {String}

Constructs new string not longer than len.

Source:

string/transform.js, line 191

Parameters:

Name	Type	Attributes	Default	Description
`str`	`String`			Text to be shortened.
`len`	`Number`	<optional>	Infinity	Desired text length.
`placing`	`Number`	<optional>	shorten.MIDDLE	Character cutting place. Can be `shorten.BEGIN`, `shorten.MIDDLE` or `shorten.END`.
`sep`	`String`	<optional>	"…"	Separator.

Returns:

Type:: String

(inner) snakeToCamel(str) → {String}

Convert this_kind_of_text to thisKindOfText.

Source:

string/transform.js, line 221

Parameters:

Name	Type	Description
`str`	`String`

Returns:

Type:: String

(inner) snakeToPascal(str) → {String}

Convert this_kind_of_text to ThisKindOfText.

Source:

string/transform.js, line 238

Parameters:

Name	Type	Description
`str`	`String`

Returns:

Type:: String

(inner) space() → {String}

Construct space.

Source:

string/consts.ts, line 68

Returns:

Type:: String

(inner) tab() → {String}

Construct tab.

Source:

string/consts.ts, line 90

Returns:

Type:: String

(inner) wrap(stropt, prefixopt, suffixopt) → {String}

Wrap passed string with prefix and suffix.

Source:

string/transform.js, line 253

Parameters:

Name	Type	Attributes	Default
`str`	`String`	<optional>	empty()
`prefix`	`String`	<optional>	empty()
`suffix`	`String`	<optional>	empty()

Returns:

Type:: String