error.md

Bashful Module: error

Overview

Purpose: Provides functions to generate error messages for common error scenarios.

Script: bashful-error.inc.sh

Unit Test Scripts: No unit test scripts exist for error.

Requires Modules: bashful

Required By Modules: None

Global Variables

Variable Name	Purpose
BASHFUL_LOADED_error	Declares that error has been loaded

Functions

Function Index

Function Name	Description
ERROR_commandExecution	Generates a message that indicates an error has occurred while executing a command. Returns a non-success status code.
ERROR_commandNotExecutable	Generates a message that indicates an error has occurred while executing a command that was not executable. Returns a non-success status code.
ERROR_invalidSettingValue	Generates a message that indicates a setting has an invalid value. Returns a non-success status code.
ERROR_missingSetting	Generates a message that indicates a required setting is missing. Returns a non-success status code.

Function API

ERROR_commandExecution

Description: Generates a message that indicates an error has occurred while executing a command. Returns a non-success status code.

ERROR_commandNotExecutable

Description: Generates a message that indicates an error has occurred while executing a command that was not executable. Returns a non-success status code.

ERROR_invalidSettingValue

Description: Generates a message that indicates a setting has an invalid value. Returns a non-success status code.

ERROR_missingSetting

Description: Generates a message that indicates a required setting is missing. Returns a non-success status code.