Related Articles

Related Articles

JavaScript string.localeCompare() Method
  • Last Updated : 02 Sep, 2020

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

  • Example:
    filter_none

    edit
    close

    play_arrow

    link
    brightness_4
    code

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

    chevron_right

    
    

  • 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:

filter_none

edit
close

play_arrow

link
brightness_4
code

<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>

chevron_right


Output:



-1
1
0

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

filter_none

edit
close

play_arrow

link
brightness_4
code

<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>

chevron_right


Output:

cse, department, geeksforgeeks, gfg

full-stack-img




My Personal Notes arrow_drop_up
Recommended Articles
Page :