JavaScript | string.localeCompare()

The string.localeCompare() is an inbuilt function 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 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 the compare string and zero (0) if the compare and reference strings are equivalent.

JavaScript code to show the working of string.localeCompare() function:

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






                        filter_none








Output:


-1
1
0


Code #2:

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







                        filter_none








Output:


cse, department, geeksforgeeks, gfg



          
          
          
          

            

    

        My Personal Notes
        arrow_drop_up
    

    

        
        

            
            
        

    


Recommended Posts:
Image
Kanchan_Ray
Check out this Author's contributed articles.
If you like GeeksforGeeks and would like to contribute, you can also write an article using contribute.geeksforgeeks.org or mail your article to contribute@geeksforgeeks.org. See your article appearing on the GeeksforGeeks main page and help other Geeks.
Please Improve this article if you find anything incorrect by clicking on  the "Improve Article" button below.


      
      
      
      

      

      
					
		

    Article Tags : 
JavaScript

           	
        

         

         
 
         
        Be the First to upvote.

                

        



        
        
        
        
        

    

            

            0
            

            

                             No votes yet.
                    

            
            
            
            
            
        

        
        

        

        

        

        

        

        


Please write to us at contribute@geeksforgeeks.org to report any issue with the above content.