@fav/text ver. 1.1.1 API document

camelCase(text) : string

Converts a string into camel case.

This function trys to split text into words with non-alphanumeric characters first. If text does not contains non-alphanumeric character, this function trys to split text into words before capital letters.

After splitting into words, this function joins them and creates a camel case string.

If text is a string which is composed of either lower case characters and numerics only (e.g. abc123), or upper case characters and numerics only (e.g. ABC123), this function regards text as one word. (At a result, this function returns a string converted into lower case, e.g. abc123).

NOTE: This function doesn't check data types of the arguments, and assumes that they are given as per the specific data types.

Parameters:

Returns:

A string converted into camel case.

Type: string

camelCase.split(text) : Array

Splits a string into alphanumeric words.

This function trys to split text into words with non-alphanumeric characters first. If text does not contains non-alphanumeric character, this function trys to split text into words before capital letters.

If text is a string which is composed of either lower case characters and numerics only (e.g. abc123), or upper case characters and numerics only (e.g. ABC123), this function regards text as one word.

NOTE: This function doesn't check data types of the arguments, and assumes that they are given as per the specific data types.

Parameters:

Returns:

An array of splitted words.

Type: Array

camelCase.join(words) : string

Joins alphanumeric words and creates a camel case string.

NOTE: This function doesn't check data types of the arguments, and assumes that they are given as per the specific data types.

Parameters:

Returns:

A camel case string.

Type: string

constantCase(text) : string

Converts a string into constant case.

This function trys to split text into words with non-alphanumeric characters first. If text does not contains non-alphanumeric character, this function trys to split text into words before capital letters.

After splitting into words, this function joins them and creates a constant case string.

If text is a string which is composed of either lower case characters and numerics only (e.g. abc123), or upper case characters and numerics only (e.g. ABC123), this function regards text as one word. (At a result, this function returns a string converted into upper case, e.g. ABC123).

NOTE: This function doesn't check data types of the arguments, and assumes that they are given as per the specific data types.

Parameters:

Returns:

A string converted into constant case.

Type: string

constantCase.split(text) : Array

Splits a string into alphanumeric words.

This function trys to split text into words with non-alphanumeric characters first. If text does not contains non-alphanumeric character, this function trys to split text into words before capital letters.

If text is a string which is composed of either lower case characters and numerics only (e.g. abc123), or upper case characters and numerics only (e.g. ABC123), this function regards text as one word.

NOTE: This function doesn't check data types of the arguments, and assumes that they are given as per the specific data types.

Parameters:

Returns:

An array of splitted words.

Type: Array

constantCase.join(words) : string

Joins alphanumeric words and creates a constant case string.

NOTE: This function doesn't check data types of the arguments, and assumes that they are given as per the specific data types.

Parameters:

Returns:

A constant case string.

Type: string

endsWith(string, target [, length]) : boolean

Checks if string ends with target. If length is specified, this function ends comparison at index length - 1.

NOTE: This function doesn't check data types of the arguments, and assumes that they are given as per the specific data types.

Parameters:

Return:

True, if string ends with target, otherwise false.

Type: boolean

escape : object

Is a set of functins to escape characters in a string.

This function set provides escapings for following syntaxes and formats:

• RegExp
• RegExpCharClass
• HtmlEntity
• HtmlAttribute

In addition, the factory functions for two types of escaping are provided:

• byProposition
• byReplacement

NOTE: These functions doesn't check data types of the arguments, and assumes that they are given as per the specific data types.

escape.RegExp(source) : string

Escapes special characters of Regular Expression.

The special characters which are escaped are as follows: ^$\.*+?()[]{}|.

The specification of the special characters of Regular Expression comes from ECMA-262 — 21.2 RegExp (Regular Expression) Objects.

Parameter:

Return:

An escaped string.

Type: string

escape.RegExpCharClass(source) : string

Escapes special characters of Regular Expression Character Class.

The special characters which are escaped are as follows: -^]\.

Parameter:

Return:

An escaped string.

Type: string

escape.HtmlEntity(source) : string

Escapes special characters of HTML entity to character references, etc.

The escape mapping for HTML entity is as follows:

Parameter:

Return:

An escaped string.

Type: string

escape.HtmlAttribute(source) : string

Escapes special characters of HTML attributes to character references.

The escape mapping for HTML attribute is as follows:

Parameter:

Return:

An escaped string.

Type: string

escape.byPreposition(escapingChar [, ...escapedChars]) : function

Creates an escape function which escapes special characters by preposition of an espacing character, for example:

var escape = fav.text.escape.byPreposition('\\', '"\'');
escape('escaping ", \' and \\.');
// => 'escaping \\", \\\' and \\\\.'

Parameter:

Return:

An escaping function.

Type: function

escape.byReplacement(escapingMap) : function

Creates an escape function which escapes special characters by replacement to corresponding strings, for examples:

var escape = fav.text.escape.byReplacement({ '"': '"', "'": ''' });
escape('escaping " and  \'.');
// => 'escaping " and '.'

Parameter:

Return:

An escaping function.

Type: function

kebabCase(text) : string

Converts a string into kebab case.

This function trys to split text into words with non-alphanumeric characters first. If text does not contains non-alphanumeric character, this function trys to split text into words before capital letters.

After splitting into words, this function joins them and creates a kebab case string.

If text is a string which is composed of either lower case characters and numerics only (e.g. abc123), or upper case characters and numerics only (e.g. ABC123), this function regards text as one word. (At a result, this function returns a string converted into lower case, e.g. abc123).

NOTE: This function doesn't check data types of the arguments, and assumes that they are given as per the specific data types.

Parameters:

Returns:

A string converted into kebab case.

Type: string

kebabCase.split(text) : Array

Splits a string into alphanumeric words.

This function trys to split text into words with non-alphanumeric characters first. If text does not contains non-alphanumeric character, this function trys to split text into words before capital letters.

If text is a string which is composed of either lower case characters and numerics only (e.g. abc123), or upper case characters and numerics only (e.g. ABC123), this function regards text as one word.

NOTE: This function doesn't check data types of the arguments, and assumes that they are given as per the specific data types.

Parameters:

Returns:

An array of splitted words.

Type: Array

kebabCase.join(words) : string

Joins alphanumeric words and creates a kebab case string.

NOTE: This function doesn't check data types of the arguments, and assumes that they are given as per the specific data types.

Parameters:

Returns:

A kebab case string.

Type: string

pad(source [, length ] [, padding ]) : string

Pads padding on left and right sides of source to center it.

If length is less than the length of source, return source with no padding.

If padding is not specified, this function use a white space ('\u0020') as a padding.

NOTE: This function doesn't check data types of the arguments, and assumes that they are given as per the specific data types.

Parameter:

Return:

The padded string.

Type: string

padLeft(source, [, length ] [, padding ]) : string

Pads padding on left side of source.

If length is less than the length of source, return source with no padding.

If padding is not specified, this function use a white space ('\u0020') as a padding.

NOTE: This function doesn't check data types of the arguments, and assumes that they are given as per the specific data type.

NOTE: This function is different from String#padStart at the point that this function uses a white space ('\u0020') as padding when specified null or an empty string to padding.

Parameter:

Return:

The padded string.

Type: string

padRight(source, [, length ] [, padding ]) : string

Pads padding on right side of source.

If length is less than the length of source, return source with no padding.

If padding is not specified, this function use a white space ('\u0020') as a padding.

NOTE: This function doesn't check data types of the arguments, and assumes that they are given as per the specific data type.

NOTE: This function is different from String#padEnd at the point that this function uses a white space ('\u0020') as padding when specified null or an empty string to padding.

Parameter:

Return:

The padded string.

Type: string

pascalCase(text) : string

Converts a string into pascal case.

This function trys to split text into words with non-alphanumeric characters first. If text does not contains non-alphanumeric character, this function trys to split text into words before capital letters.

After splitting into words, this function joins them and creates a pascal case string.

If text is a string which is composed of either lower case characters and numerics only (e.g. abc123), or upper case characters and numerics only (e.g. ABC123), this function regards text as one word.

NOTE: This function doesn't check data types of the arguments, and assumes that they are given as per the specific data types.

Parameters:

Returns:

A string converted into pascal case.

Type: string

pascalCase.split(text) : Array

Splits a string into alphanumeric words.

This function trys to split text into words with non-alphanumeric characters first. If text does not contains non-alphanumeric character, this function trys to split text into words before capital letters.

If text is a string which is composed of either lower case characters and numerics only (e.g. abc123), or upper case characters and numerics only (e.g. ABC123), this function regards text as one word.

NOTE: This function doesn't check data types of the arguments, and assumes that they are given as per the specific data types.

Parameters:

Returns:

An array of splitted words.

Type: Array

pascalCase.join(words) : string

Joins alphanumeric words and creates a pascal case string.

NOTE: This function doesn't check data types of the arguments, and assumes that they are given as per the specific data types.

Parameters:

Returns:

A pascal case string.

Type: string

repeat(source, ntimes) : string

Repeat source ntimes times.

NOTE: This function doesn't check data types of the arguments, and assumes that they are given as per the specific data types.

Parameter:

Return:

The repeated string.

Type: string

snakeCase(text) : string

Converts a string into snake case.

This function trys to split text into words with non-alphanumeric characters first. If text does not contains non-alphanumeric character, this function trys to split text into words before capital letters.

After splitting into words, this function joins them and creates a snake case string.

If text is a string which is composed of either lower case characters and numerics only (e.g. abc123), or upper case characters and numerics only (e.g. ABC123), this function regards text as one word. (At a result, this function returns a string converted into lower case, e.g. abc123).

NOTE: This function doesn't check data types of the arguments, and assumes that they are given as per the specific data types.

Parameters:

Returns:

A string converted into snake case.

Type: string

snakeCase.split(text) : Array

Splits a string into alphanumeric words.

This function trys to split text into words with non-alphanumeric characters first. If text does not contains non-alphanumeric character, this function trys to split text into words before capital letters.

If text is a string which is composed of either lower case characters and numerics only (e.g. abc123), or upper case characters and numerics only (e.g. ABC123), this function regards text as one word.

NOTE: This function doesn't check data types of the arguments, and assumes that they are given as per the specific data types.

Parameters:

Returns:

An array of splitted words.

Type: Array

snakeCase.join(words) : string

Joins alphanumeric words and creates a snake case string.

NOTE: This function doesn't check data types of the arguments, and assumes that they are given as per the specific data types.

Parameters:

Returns:

A snake case string.

Type: string

startsWith(string, target [, startIndex]) : boolean

Checks if string starts with target. If startIndex is specified this function starts comparison from startIndex.

NOTE: This function doesn't check data types of the arguments, and assumes that they are given as per the specific data types.

Parameters:

Return:

True, if string starts with target, otherwise false.

Type: boolean

trim(source [, chars]) : string

Removes leading and trailing white spaces or chars from source.

NOTE: This function doesn't check data types of the arguments, and assumes that they are given as per the specific data types.

Parameters:

Return:

The trimmed string.

Type: string

trimLeft(source [, chars]) : string

Removes leading white spaces or chars from source.

NOTE: This function doesn't check data types of the arguments, and assumes that they are given as per the specific data types.

Parameters:

Return:

The trimmed string.

Type: string

trimRight(source [, chars]) : string

Removes trailing white spaces or chars from source.

NOTE: This function doesn't check data types of the arguments, and assumes that they are given as per the specific data types.

Parameters:

Return:

The trimmed string.

Type: string

unique() : string

Returns an unique string in the application.

This unique string is not fixed-length and uses characters: a-z0-9.

This function creates an unique string with following methods:

new Date().getTime().toString(36) + <sequencial-number-in-application>.toString(36)

NOTE: On a browser, the string returned by this function is unique in only the window.

Return:

An unique string in the application.

Type: string