JavaScript string.localeCompare() Method

Below is the example of the string.localeCompare() Method.

• Example:

  <script>
      gfg = 'b'.localeCompare('a');
      document.write(gfg + '<br>')
  </script>
• Output:

  1

The string.localeCompare() is an inbuilt method in JavaScript which is used to compare any two elements and returns a positive number if the reference string is lexicographically greater than the compare string and negative number if the reference string is lexicographically smaller than the compare string and zero (0) if the compare and reference strings are equivalent.
Syntax:

referenceString.localeCompare(compareString)

Parameters: Here the parameter compareString is a string with which the reference string is compared.
Return Values: It returns a positive number if the reference string is lexicographically greater than the compare string and negative number if the reference string is lexicographically smaller than the compare string and zero (0) if the compare and reference strings are equivalent.

JavaScript code to show the working of string.localeCompare() method:
Code #1:

<script>

    // An alphabet "n" comes before "z" which
    // gives a negative value
    a = 'n'.localeCompare('z');
    document.write(a + '<br>')

    // Alphabetically the word "gfg" comes after
    // "geeksforgeeks" which gives a positive value
    b = 'gfg'.localeCompare('geeksforgeeks');
    document.write(b + '<br>')

    // "gfg" and "gfg" are equivalent which
    // gives a value of zero(0)
    c = 'a'.localeCompare('a');
    document.write(c)

</script>

Output:

-1
1
0

Code #2: This method also used to sort elements.

<script>

    // Taking some elements to sort alphabetically
    var elements = [ 'gfg', 'geeksforgeeks', 'cse', 'department' ];
    a = elements.sort((a, b) => a.localeCompare(b));

    // Returning sorted elements
    document.write(a)

</script>

Output:

cse, department, geeksforgeeks, gfg

Supported Browsers:

• Chrome 1 and above
• Edge 12 and above
• Firefox 1 and above
• Internet Explorer 5.5 and above
• Opera 7 and and above
• Safari 3 and above