JavaScript String localeCompare() Method

The name of the pictureThe name of the pictureThe name of the pictureClash Royale CLAN TAG#URR8PPP








googletag.cmd.push(function() googletag.display('div-gpt-ad-1422003450156-2'); );



JavaScript String localeCompare() Method



❮ Previous
JavaScript String Reference
Next ❯

<!--

❮ JavaScript String Reference

-->


Example


Compare two strings in the current locale:



var str1 = "ab";
var str2 = "cd";
var n = str1.localeCompare(str2);

<!--<!--

The result of n will be:



-1 // str1 is sorted before str2
-->
Try it Yourself »

More "Try it Yourself" examples below.


Definition and Usage


The localeCompare() method compares two strings in the current locale.


The locale is based on the language settings of the browser.


The localeCompare() method returns a number indicating whether the string
comes before, after or is equal as the compareString in sort order.


Browser Support














Method
localeCompare() Yes Yes Yes Yes Yes

Syntax



string.localeCompare(compareString)

Parameter Values





Parameter Description
compareString Required. The string to compare with





googletag.cmd.push(function() googletag.display('div-gpt-ad-1493883843099-0'); );




Technical Details






Return Value: A Number, indicating whether the reference string comes before, after or is the same as the compareString in sort order.
Returns one of three values:
  • -1 if the reference string is sorted before the
    compareString

  • 0 if the two strings are equal

  • 1 if the reference string is sorted after the compareString

JavaScript Version: ECMAScript 1

More Examples




Example


Compare two strings in the current locale:



var str1 = "cd";
var str2 = "ab";
var n = str1.localeCompare(str2);

<!--<!--

The result of n will be:



1 // str1 is sorted after str2
-->
Try it Yourself »



Example


Compare two equal strings in the current locale:



var str1 = "ab";
var str2 = "ab";
var n = str1.localeCompare(str2);

<!--<!--

The result of n will be:



0 // the two strings are equal
-->
Try it Yourself »



❮ Previous
JavaScript String Reference
Next ❯

<!--

❮ JavaScript String Reference

-->

-