JavaScript Documentation: util_string.js

<<BACK

Summary: Random functions for creating, manipulating and analyzing strings.

Function	Summary
isNum	Is the provided string a legal number?
isEml	Is the provided string a properly-formatted email address?
trmChr	Trim all contiguous instances of the provided character from the ends of a string
gtCd4V	Get the provided value returned as a string, and suitable for insertion into code.

util_string.js: Overview

Random functions for creating, manipulating and analyzing strings.

TOP     util_string.isNum()

Is the provided string a legal number?

PARAMETERS

• s_potential: The string to analyze. REQUIRED
• bs_decimalAllowed: Is the potential number allowed to be a decimal? If 'true', then yes. If 'false', no. REQUIRED.

RETURNS

• true if...
  • s_potential is a legal integer (regardless the value of bs_decimalAllowed). A legal integer is a string that...
    • ...contains one or more zeros. Note that 0 equals 0000 equals 0000000000 equals ...
    • ...starts with zero or one dashes (indicating negative), followed by one or more digits (0-9), where at least one is greater than zero.
  • If bs_decimalAllowed is 'true' and s_potential is a legal decimal. A legal decimal is a string that...
    • ...is an integer.
    • ...starts with zero or one dashes (indicating negative) followed by zero or more digits, followed by a decimal point ('.'), followed by *one* or more digits.
  Note that s_potential is checked to be an integer first. If it is, then true is returned, regardless the value of bs_decimalAllowed. If the string is an integer, it is not checked, specifically, to see if it's a decimal. Hence, the description of a legal decimal number says "a decimal point" instead of "zero or one decimal points".
• false if otherwise

LEGAL EXAMPLES (both integers and decimals)

• -1
• 0
• 1
• -50
• 8750328754
• 00008750328754
• 08750328754
• -487584758475235
• -0000000487584758475235
• -0487584758475235

ILLEGAL EXAMPLES (both integers and decimals)

• 4875847-58475235
• 487584758475235-
• [EMPTY_STRING]
• a
• 0-
• -0
• Not a number!!!
• Some 123 numbers 456
• 123 456
• -0.0
• -.0
• -0.000000
• -.000000
• 1.

LEGAL EXAMPLES (decimals, but only after it is determined that the value is *not* an integer)

• 1.1
• 1.000830847018374
• 058763408562473.01837486564417308746
• .1
• .0
• .01
• -1.0

SIGNATURE

isNum(s_potential, bs_decimalAllowed)

TOP     util_string.isEml()

Is the provided string a properly-formatted email address?

A 'bad' email has any of the following characteruistics:

• Is undefined or zero characters in length.
• Contains no spaces (' '), slashes ('/' or '\\'), or commas (',').
• Has a dot ('.') immediately followed or preceded by at-sign ('@').
• First or last character is a dot or at-sign.
• Contains zero or more than one at-sign.
• No dot (non-immediately) follows the at-sign

PARAMETERS

• s_potentialEmail: The string to check for email-ness. REQUIRED.

RETURNS

• true if s_potentialEmail
• false if not.

GOOD EXAMPLES

• bla@bloo.com
• bla.blee@bloo.blay.com
• bla_blee@bloo_blay.com
• x@x.x
• x.x.x.x.x.@x.x.x.x.x.x.x.x.x

BAD EXAMPLES

• x
• @
• .
• @@
• ..
• @.
• .@
• bla @ bloo . com
• [A SPACE]
• bla@bloo.com
• bla@bl oo.com
• bla.@.bloo.com
• bla@bloo.combla@bloo.com

SIGNATURE

isEml(s_potentialEmail)

TOP     util_string.trmChr()

Trim all contiguous instances of the provided character from the ends of a string

PARAMETERS

• c_harToTrim: The character to trim off of s_tring. REQUIRED and must be a character/string-of-length-one.
• s_tring: The string to trim. REQUIRED.

SIGNATURE

trmChr(c_harToTrim, s_tring)

TOP     util_string.gtCd4V()

Get the provided value returned as a string, and suitable for insertion into code.

PARAMETERS

• s_value: The value to code-ize.

RETURNS

• "undefined" when s_value is undefined.
• s_value when s_value is a number.
• "['" + s_value.join("', '") + "']" when s_value is an array.
• "'" + s_value + "'" if otherwise.
• Not sure if there's a definitive way to return a boolean without quotes... So for now, you'll always get a boolean value returned as if it were a string.

SIGNATURE

gtCd4V(s_value)