Class Index | File Index

Classes


Namespace atropa.inquire


Version 20120909.
Container for functions that test the state of inputs.
Defined in: <node_modules/atropa-inquire/src/atropa-inquire.js>.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
Container for functions that test the state of inputs.
Method Summary
Method Attributes Method Name and Description
<static>  
atropa.inquire.hasProperty(obj, prop)
Checks an object for the existence of a property regardless of whether the property was inherited or not.
<static>  
atropa.inquire.isEmptyString(str)
Checks whether the input is an empty string.
<static>  
atropa.inquire.isNull(x)
Checks whether the input is null.
<static>  
atropa.inquire.isObject(x)
Checks whether the input is an object.
<static>  
atropa.inquire.isObjectNotNull(x)
Checks whether the input is both an object and not null.
Namespace Detail
atropa.inquire
Container for functions that test the state of inputs.
Author: Matthew Christopher Kastor-Inare III
☭ Hial Atropa!! ☭.
Method Detail
<static> {Boolean} atropa.inquire.hasProperty(obj, prop)
Checks an object for the existence of a property regardless of whether the property was inherited or not.
Author: Matthew Christopher Kastor-Inare III
☭ Hial Atropa!! ☭.
Parameters:
{Object} obj
An object which may or may not have the property identified by prop.
{String} prop
A string value representing the name of the property.
Returns:
{Boolean} Returns true if obj.prop exists, otherwise returns false.

<static> {Boolean} atropa.inquire.isEmptyString(str)
Checks whether the input is an empty string.
Author: Matthew Christopher Kastor-Inare III
☭ Hial Atropa!! ☭.
Parameters:
{String} str
The string you want to know about
Returns:
{Boolean} Returns true if str is an empty string, otherwise returns false.

<static> {Boolean} atropa.inquire.isNull(x)
Checks whether the input is null.
Author: Matthew Christopher Kastor-Inare III
☭ Hial Atropa!! ☭.
Parameters:
{Mixed} x
Any input that may or may not be null.
Returns:
{Boolean} Returns true if x === null.

<static> {Boolean} atropa.inquire.isObject(x)
Checks whether the input is an object.
Author: Matthew Christopher Kastor-Inare III
☭ Hial Atropa!! ☭.
Parameters:
{Mixed} x
Any input that may or may not be an object.
Returns:
{Boolean} Returns true if typeof(x) === 'object'.

<static> {Boolean} atropa.inquire.isObjectNotNull(x)
Checks whether the input is both an object and not null.
Author: Matthew Christopher Kastor-Inare III
☭ Hial Atropa!! ☭.
Parameters:
{Mixed} x
Any input that may or may not be both an object and null.
Returns:
{Boolean} Returns true if x is both an object and not null. (null is an object).

Documentation generated by JsDoc Toolkit 2.4.0 on Thu Nov 17 2022 14:29:55 GMT-0500 (Eastern Standard Time)