## DuString

JavaScript String related methods

View Source DuAEF_Duik_api.jsxinc, line 5625

# Methods

#### # static args(string, args) → {string}

Replaces all occurences of "{#}" in the string by the args.

##### Parameters:

Name | Type | Description
--- | --- | ---
`string` | `string` | The original string
`args` | `Array.<string>` | `string` | The arguments

View Source DuAEF_Duik_api.jsxinc, line 5684

Returns:
The new string
Type: `string`

#### # static capitalize(text) → {string}

Sets the first character of the text to be capital case if it's a letter.
Note that the string is left trimmed first: any leading white space is removed.

##### Parameters:

Name | Type | Description
--- | --- | ---
`text` | `string` | The source text

View Source DuAEF_Duik_api.jsxinc, line 5860

Returns:
The new text
Type: `string`

#### # static endsWith(str, suffix) → {bool}

Checks if a string ends with a given suffix

##### Parameters:

Name | Type | Description
--- | --- | ---
`str` | `string` | The string to check
`suffix` | `string` | The suffix

View Source DuAEF_Duik_api.jsxinc, line 5705

Returns:
Whether the string ends with the given suffix or not
Type: `bool`

#### # static fromSize(size) → {string}

Converts a size in Bytes to a human-readable string with a fitting unit automatically chosen
Note that the conversion uses 1024 Bytes per kB.

##### Parameters:

Name | Type | Description
--- | --- | ---
`size` | `int` | The size in Bytes

View Source DuAEF_Duik_api.jsxinc, line 5831

Returns:
The stringified size
Type: `string`

#### # static fullTrim(str) → {String}

Returns a copy of the string without leading and trailing white spaces, and without any new line, leaving only standard spaces.

##### Parameters:

Name | Type | Description
--- | --- | ---
`str` | `string` | The string to trim

View Source DuAEF_Duik_api.jsxinc, line 5811

Returns:
The trimmed string
Type: `String`

#### # static generateUnique(newString, stringList, incrementopt, isFileopt) → {string}

Generates a new unique string (numbered)

##### Parameters:

Name | Type | Attributes | Default | Description
--- | --- | --- | --- | ---
`newString` | `string` |  |  | The wanted new string
`stringList` | `Array.<string>` |  |  | The list of strings where the new one must be generateUnique
`increment` | `boolean` | <optional> | true | true to automatically increment the new name if it already ends with a digit
`isFile` | `boolean` | <optional> | false | when generating name for files, setting this to true will add the increment before the extension

View Source DuAEF_Duik_api.jsxinc, line 5728

Returns:
The unique string, with a new number at the end if needed.
Type: `string`

#### # static leftTrim(str) → {String}

Returns a copy of the string without leading white spaces.

##### Parameters:

Name | Type | Description
--- | --- | ---
`str` | `string` | The string to trim

View Source DuAEF_Duik_api.jsxinc, line 5793

Returns:
The trimmed string
Type: `String`

#### # static occurences(string, item) → {int}

Counts the number of occurences of item in string

##### Parameters:

Name | Type | Description
--- | --- | ---
`string` | `string` | The string where to count
`item` | `string` | the string to search

View Source DuAEF_Duik_api.jsxinc, line 5634

Returns:
the number of occurences
Type: `int`

#### # static parseBool(string, caseSensitiveopt) → {boolean}

Parses the string as a boolean.
The following strings are falsy:
'false', '0', '', 'null', 'undefined', 'NaN'.
Note that any string consisiting only in any number of 0 will be falsy.

##### Parameters:

Name | Type | Attributes | Default | Description
--- | --- | --- | --- | ---
`string` | `string` |  |  | The string to parse
`caseSensitive` | `boolean` | <optional> | true | When false, 'FALSE', 'nan', 'UNdefined'... for example will be falsy too.

View Source DuAEF_Duik_api.jsxinc, line 5648

Returns:
The resulting boolean
Type: `boolean`

#### # static replace(string, find, replace, caseSensitiveopt) → {string}

Replaces all occurences of a substring by another and returns the new string.

##### Parameters:

Name | Type | Attributes | Default | Description
--- | --- | --- | --- | ---
`string` | `string` |  |  | The original string
`find` | `string` |  |  | The substring to replace
`replace` | `string` |  |  | The new substring to insert
`caseSensitive` | `boolean` | <optional> | true | Optionnal. Do a case sensitive search of substring.

View Source DuAEF_Duik_api.jsxinc, line 5671

Returns:
The new string
Type: `string`

#### # static rightTrim(str) → {String}

Returns a copy of the string without trailing white spaces.

##### Parameters:

Name | Type | Description
--- | --- | ---
`str` | `string` | The string to trim

View Source DuAEF_Duik_api.jsxinc, line 5802

Returns:
The trimmed string
Type: `String`

#### # static startsWith(str, suffix) → {bool}

Checks if a string starts with a given prefix

##### Parameters:

Name | Type | Description
--- | --- | ---
`str` | `string` | The string to check
`suffix` | `string` | The suffix

View Source DuAEF_Duik_api.jsxinc, line 5716

Returns:
Whether the string ends with the given suffix or not
Type: `bool`

#### # static toCamelCase(text) → {string}

Generates a camel case text from a snake case or standard one

##### Parameters:

Name | Type | Description
--- | --- | ---
`text` | `string` | The source text

View Source DuAEF_Duik_api.jsxinc, line 5844

Returns:
The camelCase version of the text
Type: `string`

#### # static trim(str) → {String}

Returns a copy of the string without leading and trailing white spaces.

##### Parameters:

Name | Type | Description
--- | --- | ---
`str` | `string` | The string to trim

View Source DuAEF_Duik_api.jsxinc, line 5784

Returns:
The trimmed string
Type: `String`

#### # static trimNumbers(str) → {String}

Returns a copy of the string without trailing white spaces and numbers.

##### Parameters:

Name | Type | Description
--- | --- | ---
`str` | `string` | The string to trim

View Source DuAEF_Duik_api.jsxinc, line 5821

Returns:
The trimmed string
Type: `String`

#### # static unCapitalize(text) → {string}

Sets the first character of the text to be lower case if it's a letter.
Note that the string is left trimmed first: any leading white space is removed.

##### Parameters:

Name | Type | Description
--- | --- | ---
`text` | `string` | The source text

View Source DuAEF_Duik_api.jsxinc, line 5873

Returns:
The new text
Type: `string`