Funciones de utilidad para uso general. [General usage utility functions.]
Modules
siFunciona
All the siFunciona system functions for stringing together functions and simplifying logic.
Version: 1.0.0
Author: Joshua Heagle [email protected]
stringHelpers
Manage how strings are manipulated with these utilities.
Version: 1.0.0
Author: Joshua Heagle [email protected]
stringHelpers.words(str) ⇒ Array.<string>
Split a string into sets of numbers or letters - the shared tokenizer behind camelCase/kabobCase/snakeCase/
titleCase, so each can rebuild the string in its own casing style.
Kind: static method of stringHelpers
| Param | Type | Description |
|---|
| str | string | The string to split. |
stringHelpers.ucFirst(str) ⇒ string
Given a string, make the first character uppercase and the rest lowercase.
Kind: static method of stringHelpers
| Param | Type | Description |
|---|
| str | string | The string to convert. |
stringHelpers.titleCase(str) ⇒ string
Given a string in kebab-case, snake_case, camelCase or 'Sentence case', convert to 'Title Case'.
Kind: static method of stringHelpers
| Param | Type | Description |
|---|
| str | string | The string to convert. |
stringHelpers.strBeforeLast(str, search) ⇒ string
Retrieve the string part before the last search match.
Kind: static method of stringHelpers
Returns: string - The portion of str before the last occurrence of search, or '' if not found.
| Param | Type | Description |
|---|
| str | string | The string to search within. |
| search | string | The substring to search for. |
stringHelpers.strBefore(str, search) ⇒ string
Retrieve the string part before the search match.
Kind: static method of stringHelpers
Returns: string - The portion of str before the first occurrence of search, or '' if not found.
| Param | Type | Description |
|---|
| str | string | The string to search within. |
| search | string | The substring to search for. |
stringHelpers.strAfterLast(str, search) ⇒ string
Retrieve the string part after the last search match.
Kind: static method of stringHelpers
Returns: string - The portion of str after the last occurrence of search, or '' if not found.
| Param | Type | Description |
|---|
| str | string | The string to search within. |
| search | string | The substring to search for. |
stringHelpers.strAfter(str, search) ⇒ string
Retrieve the string part after the search match.
Kind: static method of stringHelpers
Returns: string - The portion of str after the first occurrence of search, or '' if not found.
| Param | Type | Description |
|---|
| str | string | The string to search within. |
| search | string | The substring to search for. |
stringHelpers.snakeCase(str) ⇒ string
Given a string in kebab-case, camelCase or 'Sentence case', convert to snake_case.
Kind: static method of stringHelpers
| Param | Type | Description |
|---|
| str | string | The string to convert. |
stringHelpers.regexEscape(str) ⇒ string
Take a string and escape the regex characters.
Kind: static method of stringHelpers
| Param | Type | Description |
|---|
| str | string | The string to escape, so it can be used literally inside a RegExp. |
stringHelpers.makeRelativePath(fromFile, toFile) ⇒ string
Compare two file paths and simplify them to a relative path.
Kind: static method of stringHelpers
Returns: string - toFile expressed relative to fromFile.
| Param | Type | Description |
|---|
| fromFile | string | The path of the file the resulting relative path will be used from. |
| toFile | string | The path of the file being referenced. |
This is the beginning of the README. Read the rest at the original. Read the full README ↗
