Helper Function Section

# Helper Function Section

This section consists of the helper function of variables which helps you to perform certain actions on the variables nodes present in the variables node section in the Arsenal panel.

# Integer Helper Function Sub-Section

This subsection consists of all the helper function nodes related to the integer.

## Integer | Is Even Node

This node helps you to check the given integer number is even or not [Even numbers are the numbers that are completely divisible by 2 and leaves the remainder zero].

### Components Of Node

1. 1.
Value – this input node point help to provide the integer number which you want to check for even.
Note input box can also be used to directly provide the number.
2. 2.
Result – this output node point gives you true if the input integer is even else it returns false if the number is not even.

## Integer | Is Odd Node

This node helps you to check the given integer number is odd or not [odd numbers are the only divisible by itself and 1].

### Components of Node

1. 1.
Value – this input node point help to provide the integer number which you want to check for odd. Note input box can also be used to directly provide the number.
2. 2.
Result – this output node point gives you true if the input integer is odd else it returns false if the number is not odd.

## Integer | Abs Node

This node helps you to convert the number to its absolute form [which mean that a negative number reconverted to positive with the help of this node].

### Components of Node

1. 1.
Value – this input node point help to provide the integer number which you wanted to convert to absolute form [negative number to positive]. Note input box can also be used to directly provide the number.
2. 2.
Result – this output node point gives you a positive number as an output if the number that you have is either negative or positive.

## Integer | IsNegative Node

This node helps you to check whether the provided number is negative or not.

### Components Of Node

1. 1.
Value – this input node point help to provide the integer number which you wanted to check for negative. Note input box can also be used to directly provide the number.
2. 2.
Result – this output node point gives you true if the provided number is negative else it returns false.

# Double Helper Function Sub-Section

This section consists of all the nodes of the helper function that you can apply to double [decimal point numbers].

## Double | Ceil Node

This node helps you to get the largest integer that is smaller than or equal to x (i.e. rounds downs the nearest integer). For example, if the input is number = 2.31 ceiling becomes 2.

### Components of Node

1. 1.
Value – this input node point help to provide the double number on which you wanted to apply ceil operation Note input box can also be used to directly provide the number.
2. 2.
Result – this output node point gives you an integer number after applying the ceil operation on a double number.

## Double | Floor Node

This node helps you to get the smallest integer that is greater than or equal to the input number (i.e. rounds up the nearest integer). For example, if the input is number = 2.31 ceiling becomes 3.
Components of Node
1. 1.
Value – this input node point help to provide the double number on which you wanted to apply ceil operation.
Note input box can also be used to directly provide the number.
2. 2.
Result – this output node point gives you an integer number after applying the ceil operation on a double number.

## Double | Round Node

This node helps you to apply rounding of the decimal numbers [Rounding means making a number simpler but keeping its value close to what it was]. For example, if the input is number = 12.3124 round becomes 12 and if number = 12.5123 output is 13.

### Components of Node

1. 1.
Value – this input node point help to provide the double number on which you wanted to apply ceil operation.
Note input box can also be used to directly provide the number.
2. 2.
Result – this output node point gives you a double number after applying the rounding operation on a double number.

## Double | Abs Node

This node helps you to convert the double [decimal point numbers] to its absolute form [which mean that a negative number reconverted to positive with the help of this node].
For example, if input number = -12.5123 it returns 12.5123 as result.

### Components of Node

1. 1.
Value – this input node point help to provide the double number which you wanted to convert to absolute form [negative number to positive].
Note input box can also be used to directly provide the number.
2. 2.
Result – this output node point gives you a positive number as an output if the number that you have is either negative or positive.

## Double | Is Negative Node

This node helps you to check whether the provided number [decimal number] is negative or not.

### Components of Node

1. 1.
Value – this input node point help to provide the double number which you wanted to check for negative.
Note input box can also be used to directly provide the number.
2. 2.
Result – this output node point gives you true if the provided number is negative else it returns false.

## Double|To Int Node

This node helps you to convert a decimal number into an integer number. For example, if the input number is 1.253 this node returns 1 as result.

### Components of Node

1. 1.
Value – this input node point help to provide the double number which you wanted to convert to an integer.
Note input box can also be used to directly provide the number.
2. 2.
Result – this output node point gives an integer number after the conversion.

# String Helper Function Sub-Section

This sub-section consists of all the helper functions related to the string. This helper function helps you to perform many operations on string with ease.

## String | Split

This node Splits the string at matches of pattern and returns a list of substrings. Finds all the matches of pattern in this string, and returns the list of the substrings between the matches.
For example If the value in string node is = "Hello world!" and Pattern value = “ ” Then it returns the list consisting of ['Hello', 'world!'];

## String | ToLowerCase

This node converts all characters in the string to lower case. If the string is already in all lower case then it returns the same string with no change.
For example – if the value of the string is "ALPHABET", then this node returns the "alphabet".

## String | ToUpperCase

This node converts all characters in this string to the upper case. If the string is already in all upper case then it returns the same string with no change.
For example – if the value of the string is "alphabet" then this node returns the "ALPHABET".

## String | Trim

this node returns the string without any leading and trailing whitespace. If the string contains leading or trailing whitespace, a new string with no leading and no trailing whitespace is returned:
For example, if the string provided is “ Dart is fun ” this node return “Dart is fun”.

## String | Replace All

This node Replaces all substrings that match from with replace.
For example, if the string provided is “resume” and the pattern is “e” and replaces it with is “E” then it returns “rEsumE” as result.

## String | SubString

This node helps you to get a portion of the provided string.
Note Indexing in a string starts from 0 instead of 1.
For example, strings “hello World” and you wanted to get only “hello” from the string you can pass start index is 0 and end index is 5 [instead of 4 because end index is exclusive].

## String | Replace Range

This node helps you to replace a portion of the string with a new provided string.
Note Indexing in a string starts from 0 instead of 1.
For example, you have a string Hello World” and you wanted to replace it with “Hey World” so you can pass start index is 0 and end index is 5 [instead of 4 because end index is exclusive], and replace String is “Hey”, then this node return “Hey World”.

## String | Concat

This node helps you to combine two Strings.
For example, string1 is ”Hello” and String2 is “World”, then it returns “HelloWorld”,
To give space between both of them pass string 2 as ” World” [with spacce] in beginning], then it returns “Hello world”.

## String | Contains

This helps you determine whether the given string consists of some world or not, if the words exist in the string it returns true otherwise it returns false.
For example, - if you wanted to determine whether the string “Hello World” consists of “Hello” or not.

## String | Equal

This node checks whether the two strings are equal or not, if they are equal it returns true otherwise it returns false.
For example, string1 = "hello" and string2 = "hello" ,it return true.

## String | IsEmpty

This node checks whether the provided string is empty or not, if the string is empty this node returns true otherwise it returns false.
For example, if provided string ="" is this node return true.
Note - this node return true even if the provided string only contains blank space with out any character.

## String | ToString

This node converts the other variables and collections like list or map into a string.
For example, you wanted to convert an integer value of 10 to string “10”. This node helps you to achieve that.

## String | Length

This node gives you the length of the provided string.
For example, the string is “Hello” – length is 5.

## String | Index Of

This node helps you to find out the index of any character present in the provided string. if the character is not present in the String then this node return -1, but f the character is already present in the string it returns the index of the first occurrence of that character.
Note - index starts from 0 in string.
For example - String = “resume” and character = “e”, Node return 1 [index of first “e” in the string].

## String | Last Index Of

This node helps you to find out the index of the last character present in the provided string means that if a string consists of multiple same characters this node returns the index of the last character.
If no matching character is present in the provided string the node return -1.
If the string consists of only a single character then this node works like the index of node and return the index of the first occurrence of character [only one character is present].
For example, string = “resume” pattern is “e” Result = 5 [index of last “e” is 5].

## String | Json to String

This node converts the JSON [Javascript Object Notion] into the string.
This node is mostly used when you are dealing with JSON responses from any web server, So in some of the cases, you need to convert the JSON into a string.

## String | String to JSON

This node helps you convert the string into JSON [Javascript object notion], Similar to the above node this node is also used when you are dealing with responses from web servers, so in some scenarios, you need to convert the JSON into the string.

## String | Parse String To

This node helps you to convert some variables like integer, double, Boolean back into the string.
For example, interger = 10 is convert inot string = “10”, or Boolean = true is converted into “true”.

## String | Compare To

This node Returns an integer representing the relationship between two strings.
0 − when the strings are equal.
1 − when the first string is greater than the second
-1 − when the first string is smaller than the second

## String | Ends With

This node return true of the provided string ends with a particular string otherwise it returns false.
for example 1. string = “hello” pattern = “llo” , result = true; 2. string “hello” pattern =”e” , result = false.

## String | Starts With

This node return true of the provided string starrts with a particular string otherwise it returns false.
for example
string = “hello” pattern = “hel” , result = true.
string “hello” pattern =”yo” , result = false.

## String | Trim Left

This node returns the string with any leading white space.
For example
1. string =” Hello” result = “Hello”.
2. string =” Resume ”, result = “Resume ”.

## String | Trim Right

This node returns the string with any leading white space.
For example
1. string =” Hello” result = “Hello”.
2. string =” Resume ”, result = “Resume ”.

# Boolean Helper Function Sub-Section

This sub-section provides you the helper function related to boolean.

## Boolean | Is Null

This node helps you to check whether the provided boolean is null or not. [a variable is said to be null if there is no value present in the variables].

# List Helper Function Sub-Section

## List | First Item

This node returns the first element of the provided list [the first element is the element which is stored at 0 index in list].
For example – list = [1,2,3,4,5] then this node return result = 1.

## List | Last Item

This node returns the last element of the provided list [the last element is the element that is stored at the last index of the list].
For example, list = [1,2,3,4,5] then this node return result = 5.

## List | Reverse

This node as the name suggest reverses the provided list.
For example, list = [1,2,3,4,5] , node result = [5,4,3,2,1].

## List | Remove At

This node removes the element at provided index, thereby reducing the length of the list by one and moves all later objects down by one position.
The provided index should be between 0 <= index < list Length.
For example, list = [1,2,3,4,5], index = 1 result list = [1,3,4,5];
Note indexing in list starts from zero.

## List | Remove Value

This node helps you to Removes the first occurrence of value from this list.
For example, list = [1,2,3,4,5,1], and value = 1, so this node return = [2,3,4,5,1].

This node helps you to Adds value to the end of this list, extending the length by one.
For example, list = [1,2,3,4,5] and value = 6, so the node return = [1,2,3,4,5,6].

## List | Add Multiple Values

This node helps you to add multiple values to a list at the same time. This operation extends the length of the list by the number of values to add to the list.
For example – list = [1,2,3], values to be added = 4, 5, 6, then the node retrun = [1,2,3,4,5,6].

This node helps you to combine two lists as a single list. The length of the result list is the sum of the length of the first and second lists.
For example, list1 = [1,2,3] and list2 = [4,5,6] and the result = [1,2,3,4,5,6].

## List | Insert At

This node helps you to insert at a particular position or index in the list, insert the item in the list that caused the increase in the length of the list by one and shifts all objects at or after the index towards the end of the list.
For example, list = [1,2,3,4] and insert at index = 2, new element = 10, the the result list = [1,2,10,3,4].

## List | Remove Range

This node helps you to multiple sets of consecutive elements from the list at once.
Removes the elements with positions greater than or equal to start and less than the end, from the list. This reduces the list's length by the end - start.
For example, list = [1,2,3,4,5,6] , start = 0, end = 2 and the result = [3,4,5,6] because end is exclusive which means that its not included.

## List | Clear

This node helps you to Removes all objects from this list; the length of the list becomes zero.
This node returns the empty list which can be used again for adding items or elements.
For example list = [1,2,3,4,5], result = [].

## List | Length

This node helps you to calculate the length of the list which gives you how many elements or items are available in the list.
For example, list = [1,2,3,4,5], length of list = 5 total 5 elements are present.

## List | Is Empty

This node helps you to check whether the provided list is empty or not, if the provided list is empty then the node returns True else it returns false.
For example, list = [1,2,3,4], the node return false, if list = [], then node returns true.

## List | Index Of

This node helps you find out the index of a particular element or item present in the list. It returns the index of the first occurrence of the element.
For example, list = [1,2,3,4], element = 3, then node result = 2.
Note – the index in the list starts from zero.

## List | Element At

This node helps you to get the element at a particular index. This node returns the value of the item or element present at the given index.
For example, list = [1,2,3,4,5,6] , index =2, then the node return 3, as indexing in list starts from zero.

# Map Helper Function Sub-Section

this section consists of all the helper function nodes of the map.

## Map | Remove

This node Removes the key and its associated value, if present, from the map. If the key mentioned is not present then no kay value is removed from the map.
For example, map {“atul”: “chaudhary”}, key = “atul”, so node removes the key-value pairs that have key matched with the provided key. In this case, the node returns an empty map because there is only one value in the map.

## Map | Clear

This node removes all the values that are present in the provided map, and then it returns the empty map.
For example, map = {“atul” : “chaudhary”}, this node return the map ={} which is empty map.

This node helps you to Adds all key/value pairs of others to this map. And If a key of other is already in the provided map, its value is overwritten [make sure that both map have unique keys].
For example, map = {“CSE”:”atul”}, other map = {“IT”: “ashutosh”}, then the node return new map = {“CSE”: “atul”, “IT”: “ashutosh”}.

## Map | Contains Key

This node returns true if the provided key is present in the map, if not then it returns false.
For example, map = {“CSE”: “atul”}, key = “CSE”, then the node return true. If the key = “IT”, then the node return false.

## Map | Contains Value

This node returns the true the map contains the provided value, if no it returns false.
For example, map = {“CSE”: “atul”}, value = “atul”, then the node return true. If the value = “ashutosh”, then the node return false.

## Map | Is Empty

This node returns true if the provided map is empty, if not then it returns false.
For example, map = {}, then the node retrun true. If the map = {“CSE”: “atul”}, then it returns false [because map consists of some value ].

## Map | Length

This node helps you calculate the length of the map [length tells that how many key-value are present in the map].
For example, map = {“CSE”: “atul”, “IT”: “ashutosh”}, length = 2 [because two key-values pairs are present].

## Map | Add Key Value

This node helps you to add key-value pairs to the existing map and return the updated map.
For example, map = {“CSE”: “atul”}, key = “IT”, value = “ashutosh”, then the node return new map = {“CSE”: “atul”, “IT”: “ashutosh”}.

## Map | Add Multiple Key Value

This node helps you to add multiple key-value pairs in a single go, this node returns the updated mao with all the newly added key-value pairs.
For example, map = {“atul”: “chaudhary”}, key1 = “sahaj” value1 = “rana”, key2 = “ashutosh” value2 = “agarwal”, the the node returns new map = {“atul” : ”chaudhary”, “sahaj”: “rana”, “ashutosh”: “agarwal”}.

## Map | Get Value

This node returns the value associated with the key passed in the node.
For example, map = {“CSE”: “atul”}, key = “atul”, then the result = “atul” [value associated with the key “CSE” is “atul”].

## Map | Get All Keys

This node gives you all the keys that are present in the map.
For example, map = {“CSE”: “atul”, “IT”: ”ashutosh”}, then node return the list = [“CSE”, “IT”].

## Map | Get All Values

This node gives you all the values that are present in the map.
For example, map = {“CSE”: “atul”, “IT”: ”ashutosh”}, then node return list = [“atul”, “ashutosh”].

# Json Helper Functions

## JSON | Get Value

Parameters
Input: Requires a JSON input. (mainly from `Response Body` field of `Simple Http`'s `On Success` function.) Var Type: String, Map, List. e.g.:
{
"store": {
"book": [
{
"category": "reference",
"author": "Nigel Rees",
"title": "Sayings of the Century",
"price": 8.95
},
{
"category": "fiction",
"author": "Evelyn Waugh",
"title": "Sword of Honour",
"price": 12.99
},
],
"bicycle": {
"color": "red",
"price": 19.95
}
}
}
Filter: Requires a string input to filter the input parameter.
Var Type: String.
e.g: `store.book.title` or `store.book[*].title`
------------------------------
Note: No need to add `\$.` at the start. (as it adds that itself.)
------------------------------ For more,
------------------------------

# DateTime Helper Function Sub-Section

This section helps you to get helper nodes related to date and time.

## DateTime | Formatter

This node helps you to convert the date time into any specific format that you wanted.
For example, if you want only time to display just time hours and minutes from DateTime just choose the Hours_minutes option from the dropdown, or if you wanted to show the only date from DateTime in the format of day/month/year choose the option year_month_day from the drop-down.

# Duration Helper Function Sub-Section

## Duration | Abs

This node helps you returned Duration has the same length as provided one, but is always positive.
If after performing some logic duration turns out to be negative then, this node converts the negative duration to positive duration.

## Duration | Compare To

This node helps you to compare the two duration.
This node returns -
1. zero if both the duration provided in the node is the same.
2. Returns a negative integer if this Duration is shorter than the other.
3. Returns a positive integer if this Duration is greater than other.
Note - A negative Duration is always considered shorter than a positive one.

## Duration | Is Negative

This node tells you whether the duration provided is negative or not. If the duration is negative then this node returns true, if the duration is not negative then this node returns false.

## Duration | Conversion

This node helps you to convert the duration into the required format like, you wanted to convert hours into minutes. This kind of functionality is possible with this node.