Visit Mozilla.org

Core JavaScript 1.5 Reference:Global Objects:Boolean

From MDC


Contents

Summary

The Boolean object is an object wrapper for a boolean value.

Syntax

new Boolean(value)

Parameters

value 
The initial value of the Boolean object.

Description

The value passed as the first parameter is converted to a boolean value, if necessary. If value is omitted or is 0, -0, null, false, NaN, undefined, or the empty string (""), the object has an initial value of false. All other values, including any object or the string "false", create an object with an initial value of true.

Do not confuse the primitive Boolean values true and false with the true and false values of the Boolean object.

Any object whose value is not undefined or null, including a Boolean object whose value is false, evaluates to true when passed to a conditional statement. For example, the condition in the following if statement evaluates to true:

x = new Boolean(false);
if (x) {
  // . . . this code is executed
}

This behavior does not apply to Boolean primitives. For example, the condition in the following if statement evaluates to false:

x = false;
if (x) {
  // . . . this code is not executed
}

Do not use a Boolean object to convert a non-boolean value to a boolean value. Instead, use Boolean as a function to perform this task:

x = Boolean(expression);     // preferred
x = new Boolean(expression); // don't use

If you specify any object, including a Boolean object whose value is false, as the initial value of a Boolean object, the new Boolean object has a value of true.

myFalse = new Boolean(false);   // initial value of false
g = new Boolean(myFalse);       // initial value of true
myString = new String("Hello"); // string object
s = new Boolean(myString);      // initial value of true

Do not use a Boolean object in place of a Boolean primitive.

Properties

For properties inherited by Boolean instances, see Properties of Boolean instances.

prototype: Defines a property that is shared by all Boolean objects.

Properties inherited from Function.prototype
caller, constructor, length, name

Methods

For methods inherited by Boolean instances, see Methods of Boolean instances.

The global Boolean object contains no methods of its own, however, it does inherit some methods through the prototype chain.

Methods inherited from Function.prototype
apply, call, toSource, toString, valueOf

Methods inherited from Object.prototype
__defineGetter__, __defineSetter__, hasOwnProperty, isPrototypeOf, __lookupGetter__, __lookupSetter__, __noSuchMethod__, propertyIsEnumerable, unwatch, watch

Boolean instances

Boolean instances inherit from Boolean.prototype. You can use the constructor's prototype object to add properties or methods to all Boolean instances.

Properties

constructor
Returns the function that created an instance's prototype. This is the Boolean function by default.

Methods

toSource
Returns a string containing the source of the Boolean object; you can use this string to create an equivalent object. Overrides the Object.prototype.toSource method.
toString
Returns a string of either "true" or "false" depending upon the value of the object. Overrides the Object.prototype.toString method.
valueOf
Returns the primitive value of the Boolean object. Overrides the Object.prototype.valueOf method.

Methods inherited from Object.prototype
__defineGetter__, __defineSetter__, hasOwnProperty, isPrototypeOf, __lookupGetter__, __lookupSetter__, __noSuchMethod__, propertyIsEnumerable, unwatch, watch

Examples

Creating Boolean objects with an initial value of false

bNoParam = new Boolean();
bZero = new Boolean(0);
bNull = new Boolean(null);
bEmptyString = new Boolean("");
bfalse = new Boolean(false);

Creating Boolean objects with an initial value of true

btrue = new Boolean(true);
btrueString = new Boolean("true");
bfalseString = new Boolean("false");
bSuLin = new Boolean("Su Lin");

See also