What does the construct x = x

2018-06-18 12:10:44

I am debugging some JavaScript, and can't explain what this || does?

function (title, msg) {
  var title = title || 'Error';
  var msg   = msg || 'Error on Request';
}

Can someone give me an hint, why this guy is using var title = title || 'ERROR' var title = title || 'ERROR' ? I sometimes see it without a var declaration as well.

It means the title argument is optional. So if you call the method with no arguments it will use a default value of "Error" .

It's shorthand for writing:

if (!title) {
  title = "Error";
}

This kind of shorthand trick with boolean expressions is common in Perl too. With the expression:

a OR b

it evaluates to true if either a or b is true . So if a is true you don't need to check b at all. This is called short-circuit boolean evaluation so:

var title = title || "Error";

basically checks if title evaluates to false . If it does, it "returns" "Error" , otherwise it returns title .

What is the double pipe operator ( `||` )?

The double pipe operator ( || ) is the logical OR operator . In most languages it works the following way:

If the first value is false , it checks the second value. If it's true , it returns true and if it's false , it returns false .

If the first value is true , it always returns true , no matter what the second value is.

So basically it works like this function:

function or(x, y) {
  if (x) {
    return true;
  } else if (y) {
    return true;
  } else {
    return false;
  }
}

If you still don't understand, look at this table:

      | true   false  
------+---------------
true  | true   true   
false | true   false

In other words, it's only false when both values are false.

How is it different in JavaScript?

JavaScript is a bit different, because it's a loosely typed language . In this case it means that you can use || operator with values that are not booleans. Though it makes no sense, you can use this operator with for example a function and an object:

(function(){}) || {}

What happens there?

If values are not boolean, JavaScript makes implicit conversation to boolean . It means that if the value is falsey (eg 0 , "" , null , undefined (see also All falsey values in JavaScript)), it will be treated as false ; otherwise it's treated as true .

So the above example should give true , because empty function is truthy. Well, it doesn't. It returns the empty function. That's because JavaScript's || operator doesn't work as I wrote at the beginning. It works the following way:

If the first value is falsey , it returns the second value .

If the first value is truthy , it returns the first value .

Surprised? Actually, it's "compatible" with the traditional || operator. It could be written as following function:

function or(x, y) {
  if (x) {
    return x;
  } else {
    return y;
  }
}

If you pass a truthy value as x , it returns x , that is, a truthy value. So if you use it later in if clause:

(function(x, y) {
  var eitherXorY = x || y;
  if (eitherXorY) {
    console.log("Either x or y is truthy.");
  } else {
    console.log("Neither x nor y is truthy");
  }
}(true/*, undefined*/));

you get "Either x or y is truthy." .

If x was falsey, eitherXorY would be y . In this case you would get the "Either x or y is truthy." if y was truthy; otherwise you'd get "Neither x nor y is truthy" .

The actual question

Now, when you know how || operator works, you can probably make out by yourself what does x = x || y x = x || y mean. If x is truthy, x is assigned to x , so actually nothing happens; otherwise y is assigned to x . It is commonly used to define default parameters in functions. However, it is often considered a bad programming practice , because it prevents you from passing a falsey value (which is not necessarily undefined or null ) as a parameter. Consider following example:

function badFunction(/* boolean */flagA) {
  flagA = flagA || true;
  console.log("flagA is set to " + (flagA ? "true" : "false"));
}

It looks valid at the first sight. However, what would happen if you passed false as flagA parameter (since it's boolean, ie can be true or false )? It would become true . In this example, there is no way to set flagA to false .

It would be a better idea to explicitly check whether flagA is undefined , like that:

function goodFunction(/* boolean */flagA) {
  flagA = typeof flagA !== "undefined" ? flagA : true;
  console.log("flagA is set to " + (flagA ? "true" : "false"));
}

Though it's longer, it always works and it's easier to understand.

You can also use the ES6 syntax for default function parameters, but note that it doesn't work in older browsers (like IE). If you want to support these browsers, you should transpile your code with Babel.

What does the construct x = x

What is the double pipe operator ( || )?

How is it different in JavaScript?

What happens there?

The actual question

What is the double pipe operator ( `||` )?