unitproc/bkt-vbm

   1 #!/bin/bash
   2 # Desc: Display message if opVerbose true
   3
   4 vbm() {
   5     # Description: Prints verbose message ("vbm") to stderr if opVerbose is set to "true".
   6     # Usage: vbm "DEBUG :verbose message here"
   7     # Version 0.2.0
   8     # Input: arg1: string
   9     #        vars: opVerbose
  10     # Output: stderr
  11     # Depends: bash 5.0.3, echo 8.30, date 8.30
  12
  13     if [ "$opVerbose" = "true" ]; then
  14         functionTime="$(date --iso-8601=ns)"; # Save current time in nano seconds.
  15         echo "[$functionTime]:$0:""$*" 1>&2;  # Display argument text.
  16     fi
  17
  18     # End function
  19     return 0; # Function finished.
  20 } # Displays message if opVerbose true
  21
  22 #==BEGIN sample code==
  23 vbm "STATUS:This is a status message.";
  24 opVerbose="true";
  25 vbm "STATUS:This is another status message.";
  26 #==END sample code==
  27
  28 # Author: Steven Baltakatei Sandoval
  29 # License: GPLv3+