bash-util/README.md

Bash Utilites

Bash library which provides utility functions and helpers for functional programming in Bash.

Table of Contents

• Array
  • array::contains()
  • array::dedupe()
  • array::join()
  • array::reverse()
  • array::random_element()
• String
  • string::trim()
  • string::split()
  • string::lstrip()
  • string::rstrip()
  • string::to_lower()
  • string::to_upper()
  • string::contains()
  • string::starts_with()
  • string::ends_with()
  • string::regex()
• License

Array

Functions for array operations and manipulations.

array::contains()

Check if item exists in the given array.

Example

array=("a" "b" "c")
array::contains "c" ${array[@]}
#Output
0

Arguments

• $1 (mixed): Item to search (needle).
• $2 (array): array to be searched (haystack).

Exit codes

• 0: If successful.
• 1: If no match found in the array.
• 2: Function missing arguments.

array::dedupe()

Remove duplicate items from the array

Example

array=("a" "b" "a" "c")
printf "%s" "$(array::dedupe ${array[@]})"
#Output
a b c

Arguments

• $1 (array): Array to be deduped.

Exit codes

• 0: If successful.
• 2: Function missing arguments.

Output on stdout

• Deduplicated array.

array::join()

Join array elements with a string.

Example

array=("a" "b" "c" "d")
printf "%s" "$(array::join "," "${array[@]}")"
#Output
a,b,c,d
printf "%s" "$(array::join "" "${array[@]}")"
#Output
abcd

Arguments

• $1 (string): String to join the array elements (glue).
• $2 (array): array to be joined with glue string.

Exit codes

• 0: If successful.
• 2: Function missing arguments.

Output on stdout

• String containing a string representation of all the array elements in the same order,with the glue string between each element.

array::reverse()

Return an array with elements in reverse order.

Example

array=(1 2 3 4 5)
printf "%s" "$(array::reverse "${array[@]}")"
#Output
5 4 3 2 1

Arguments

• $1 (array): The input array.

Exit codes

• 0: If successful.
• 2: Function missing arguments.

Output on stdout

• The reversed array.

array::random_element()

Returns a random item from the array.

Example

array=("a" "b" "c" "d")
printf "%s\n" "$(array::random_element "${array[@]}")"
#Output
c

Arguments

• $1 (array): The input array.

Exit codes

• 0: If successful.
• 2: Function missing arguments.

Output on stdout

• Random item out of the array.

String

Functions for string operations and manipulations.

string::trim()

Strip whitespace from the beginning and end of a string.

Example

echo "$(string::trim "   Hello World!   ")"
#Output
Hello World!

Arguments

• $1 (The): string that will be trimmed.

Exit codes

• 0: If successful.
• 2: Function missing arguments.

Output on stdout

• The trimmed string.

string::split()

Split a string to array by a delimiter.

Example

printf "%s" "$(string::split "Hello!World" "!")"
#Output
Hello
World

Arguments

• $1 (string): The input string.
• $2 (string): The delimiter string.

Exit codes

• 0: If successful.
• 2: Function missing arguments.

Output on stdout

• Returns an array of strings created by splitting the string parameter by the delimiter.

string::lstrip()

Strip characters from the beginning of a string.

Example

echo "$(string::lstrip "Hello World!" "He")"
#Output
llo World!

Arguments

• $1 (string): The input string.
• $2 (string): The characters you want to strip.

Exit codes

• 0: If successful.
• 2: Function missing arguments.

Output on stdout

• Returns the modified string.

string::rstrip()

Strip characters from the end of a string.

Example

echo "$(string::rstrip "Hello World!" "d!")"
#Output
Hello Worl

Arguments

• $1 (string): The input string.
• $2 (string): The characters you want to strip.

Exit codes

• 0: If successful.
• 2: Function missing arguments.

Output on stdout

• Returns the modified string.

string::to_lower()

Make a string lowercase.

Example

echo "$(string::to_lower "HellO")"
#Output
hello

Arguments

• $1 (string): The input string.

Exit codes

• 0: If successful.
• 2: Function missing arguments.

Output on stdout

• Returns the lowercased string.

string::to_upper()

Make a string all uppercase.

Example

echo "$(string::to_upper "HellO")"
#Output
HELLO

Arguments

• $1 (string): The input string.

Exit codes

• 0: If successful.
• 2: Function missing arguments.

Output on stdout

• Returns the uppercased string.

string::contains()

Check whether the search string exists within the input string.

Example

string::contains "Hello World!" "lo"

Arguments

• $1 (string): The input string.
• $2 (string): The search key.

Exit codes

• 0: If match found.
• 1: If no match found.
• 2: Function missing arguments.

string::starts_with()

Check whether the input string starts with key string.

Example

string::starts_with "Hello World!" "He"

Arguments

• $1 (string): The input string.
• $2 (string): The search key.

Exit codes

• 0: If match found.
• 1: If no match found.
• 2: Function missing arguments.

string::ends_with()

Check whether the input string ends with key string.

Example

string::ends_with "Hello World!" "d!"

Arguments

• $1 (string): The input string.
• $2 (string): The search key.

Exit codes

• 0: If match found.
• 1: If no match found.
• 2: Function missing arguments.

string::regex()

Check whether the input string matches the given regex.

Example

string::regex "HELLO" "^[A-Z]*$"

Arguments

• $1 (string): The input string.
• $2 (string): The search key.

Exit codes

• 0: If match found.
• 1: If no match found.
• 2: Function missing arguments.

License

MIT