Class StringHandler

Provides string manipulation functions for use in HotMesh mapping rules. Although inspired by JavaScript's String API, these methods follow a functional approach where each transformation expects one or more input parameters from the prior row in the @pipe structure.

Remarks

Methods are invoked with the syntax {@string.<method>}, e.g., {@string.trim} or {@string.toUpperCase}.

Index

Constructors

constructor

Methods

charAt concat endsWith includes indexOf lastIndexOf padEnd padStart repeat replace search slice split startsWith substring toLowerCase toUpperCase trim trimEnd trimStart

Constructors

constructor

new StringHandler(): StringHandler
Returns StringHandler

Methods

charAt

charAt(input, index): string
Retrieves the character at a specified index in a string.
Parameters
- input: string
  The string to retrieve the character from.
- index: number
  The zero-based index of the character.
Returns string
The character at the specified index.
Example
```
first_letter:
  "@pipe":
    - ["{a.output.data.word}", 0]
    - ["{@string.charAt}"]
```
- Defined in services/pipe/functions/string.ts:43

concat

concat(...strings): string
Concatenates two or more strings into a single string.
Parameters
- Rest...strings: string[]
  The strings to concatenate.
Returns string
The concatenated result.
Example
```
full_name:
  "@pipe":
    - ["{a.output.data.first_name}", " ", "{a.output.data.last_name}"]
    - ["{@string.concat}"]
```
- Defined in services/pipe/functions/string.ts:60

endsWith

endsWith(str, searchString, length?): boolean
Determines whether a string ends with the characters of a specified string, optionally limiting the check to the first N characters.
Parameters
- str: string
  The string to check.
- searchString: string
  The characters to search for at the end.
- Optionallength: number
  Optional length of the string to consider.
Returns boolean
true if the string ends with the search string, false otherwise.
Example
```
ends_with_dot:
  "@pipe":
    - ["{a.output.data.sentence}", "."]
    - ["{@string.endsWith}"]
```
- Defined in services/pipe/functions/string.ts:369

includes

includes(input, searchString, position?): boolean
Checks if a string contains a specified substring, optionally starting the search at a given position.
Parameters
- input: string
  The string to search within.
- searchString: string
  The substring to search for.
- Optionalposition: number
  Optional position to start searching from.
Returns boolean
true if the substring is found, false otherwise.
Example
```
contains_fox:
  "@pipe":
    - ["{a.output.data.sentence}", "fox"]
    - ["{@string.includes}"]
```
- Defined in services/pipe/functions/string.ts:80

indexOf

indexOf(input, searchString, fromIndex?): number
Returns the index of the first occurrence of a specified substring in a string, or -1 if not found.
Parameters
- input: string
  The string to search within.
- searchString: string
  The substring to search for.
- OptionalfromIndex: number
  Optional index to start searching from.
Returns number
The index of the first occurrence, or -1.
Example
```
fox_index:
  "@pipe":
    - ["{a.output.data.sentence}", "fox"]
    - ["{@string.indexOf}"]
```
- Defined in services/pipe/functions/string.ts:100

lastIndexOf

lastIndexOf(input, searchString, fromIndex?): number
Returns the index of the last occurrence of a specified substring in a string, or -1 if not found.
Parameters
- input: string
  The string to search within.
- searchString: string
  The substring to search for.
- OptionalfromIndex: number
  Optional index to start searching backward from.
Returns number
The index of the last occurrence, or -1.
Example
```
last_quick_index:
  "@pipe":
    - ["{a.output.data.sentence}", "quick"]
    - ["{@string.lastIndexOf}"]
```
- Defined in services/pipe/functions/string.ts:120

padEnd

padEnd(input, maxLength, padString?): string
Pads the end of a string with a given pad string (repeated if needed) until the resulting string reaches the specified maximum length.
Parameters
- input: string
  The string to pad.
- maxLength: number
  The target length of the resulting string.
- OptionalpadString: string
  The string to pad with (defaults to spaces).
Returns string
The padded string.
Example
```
padded:
  "@pipe":
    - ["{a.output.data.value}", 10, "."]
    - ["{@string.padEnd}"]
```
- Defined in services/pipe/functions/string.ts:265

padStart

padStart(input, maxLength, padString?): string
Pads the start of a string with a given pad string (repeated if needed) until the resulting string reaches the specified maximum length.
Parameters
- input: string
  The string to pad.
- maxLength: number
  The target length of the resulting string.
- OptionalpadString: string
  The string to pad with (defaults to spaces).
Returns string
The padded string.
Example
```
padded:
  "@pipe":
    - ["{a.output.data.value}", 5, "0"]
    - ["{@string.padStart}"]
```
- Defined in services/pipe/functions/string.ts:245

repeat

repeat(str, count): string
Creates a new string by repeating the given string a specified number of times. The count must be a non-negative finite number.
Parameters
- str: string
  The string to repeat.
- count: number
  The number of times to repeat (must be >= 0 and finite).
Returns string
The repeated string.
Example
```
repeated_text:
  "@pipe":
    - ["{a.output.data.text}", 3]
    - ["{@string.repeat}"]
```
- Defined in services/pipe/functions/string.ts:388

replace

replace(input, searchValue, replaceValue): string
Replaces the first occurrence of a search value (string or RegExp) in a string with a replacement string.
Parameters
- input: string
  The string to search within.
- searchValue: string | RegExp
  The value to search for.
- replaceValue: string
  The replacement string.
Returns string
The string with the first match replaced.
Example
```
replaced:
  "@pipe":
    - ["{a.output.data.text}", "old", "new"]
    - ["{@string.replace}"]
```
- Defined in services/pipe/functions/string.ts:285

search

search(input, regexp): number
Searches a string for a match against a regular expression and returns the index of the first match, or -1 if no match is found.
Parameters
- input: string
  The string to search within.
- regexp: RegExp
  The regular expression to search for.
Returns number
The index of the first match, or -1.
Example
```
match_index:
  "@pipe":
    - ["{a.output.data.text}", "/\\d+/"]
    - ["{@string.search}"]
```
- Defined in services/pipe/functions/string.ts:308

slice

slice(input, start?, end?): string
Extracts a section of a string and returns it as a new string, without modifying the original.
Parameters
- input: string
  The string to extract from.
- Optionalstart: number
  The zero-based start index (inclusive).
- Optionalend: number
  The zero-based end index (exclusive).
Returns string
The extracted substring.
Example
```
substring:
  "@pipe":
    - ["{a.output.data.sentence}", 4, 9]
    - ["{@string.slice}"]
```
- Defined in services/pipe/functions/string.ts:140

split

split(input, delimiter): string[]
Splits a string into an array of substrings based on a specified delimiter.
Parameters
- input: string
  The string to split.
- delimiter: string
  The delimiter to split on.
Returns string[]
An array of substrings.
Example
```
words:
  "@pipe":
    - ["{a.output.data.sentence}", " "]
    - ["{@string.split}"]
```
- Defined in services/pipe/functions/string.ts:25

startsWith

startsWith(str, searchString, position?): boolean
Determines whether a string begins with the characters of a specified string, optionally starting the check at a given position.
Parameters
- str: string
  The string to check.
- searchString: string
  The characters to search for at the start.
- Optionalposition: number
  Optional position to begin searching from.
Returns boolean
true if the string starts with the search string, false otherwise.
Example
```
starts_with_the:
  "@pipe":
    - ["{a.output.data.sentence}", "The"]
    - ["{@string.startsWith}"]
```
- Defined in services/pipe/functions/string.ts:349

substring

substring(input, start, end?): string
Returns a portion of a string between the specified start and end indices. Unlike slice, negative indices are treated as 0 and arguments are swapped if start is greater than end.
Parameters
- input: string
  The string to extract from.
- start: number
  The start index (inclusive).
- Optionalend: number
  The end index (exclusive).
Returns string
The extracted substring.
Example
```
substring:
  "@pipe":
    - ["{a.output.data.sentence}", 4, 9]
    - ["{@string.substring}"]
```
- Defined in services/pipe/functions/string.ts:329

toLowerCase

toLowerCase(input): string
Converts all characters in a string to lowercase.
Parameters
- input: string
  The string to convert.
Returns string
The lowercase string.
Example
```
lowercase_sentence:
  "@pipe":
    - ["{a.output.data.sentence}"]
    - ["{@string.toLowerCase}"]
```
- Defined in services/pipe/functions/string.ts:157

toUpperCase

toUpperCase(input): string
Converts all characters in a string to uppercase.
Parameters
- input: string
  The string to convert.
Returns string
The uppercase string.
Example
```
uppercase_sentence:
  "@pipe":
    - ["{a.output.data.sentence}"]
    - ["{@string.toUpperCase}"]
```
- Defined in services/pipe/functions/string.ts:174

trim

trim(input): string
Removes whitespace from both ends of a string.
Parameters
- input: string
  The string to trim.
Returns string
The trimmed string.
Example
```
trimmed_text:
  "@pipe":
    - ["{a.output.data.text}"]
    - ["{@string.trim}"]
```
- Defined in services/pipe/functions/string.ts:191

trimEnd

trimEnd(input): string
Removes whitespace from the end of a string.
Parameters
- input: string
  The string to trim.
Returns string
The string with trailing whitespace removed.
Example
```
trimmed_end_text:
  "@pipe":
    - ["{a.output.data.text}"]
    - ["{@string.trimEnd}"]
```
- Defined in services/pipe/functions/string.ts:225

trimStart

trimStart(input): string
Removes whitespace from the beginning of a string.
Parameters
- input: string
  The string to trim.
Returns string
The string with leading whitespace removed.
Example
```
trimmed_start_text:
  "@pipe":
    - ["{a.output.data.text}"]
    - ["{@string.trimStart}"]
```
- Defined in services/pipe/functions/string.ts:208

Class StringHandler

Remarks

Index

Constructors

Methods

Constructors

constructor

Returns StringHandler

Methods

charAt

Parameters

Returns string

Example

concat

Parameters

Returns string

Example

endsWith

Parameters

Returns boolean

Example

includes

Parameters

Returns boolean

Example

indexOf

Parameters

Returns number

Example

lastIndexOf

Parameters

Returns number

Example

padEnd

Parameters

Returns string

Example

padStart

Parameters

Returns string

Example

repeat

Parameters

Returns string

Example

replace

Parameters

Returns string

Example

search

Parameters

Returns number

Example

slice

Parameters

Returns string

Example

split

Parameters

Returns string[]

Example

startsWith

Parameters

Returns boolean

Example

substring

Parameters

Returns string

Example

toLowerCase

Parameters

Returns string

Example

toUpperCase

Parameters

Returns string

Example

trim

Parameters

Returns string