JavaScript String Compare

The JavaScript LocaleCompare function is one of the JavaScript String Function which is used to compare two strings and check whether the two strings are equal or not?. In this article we will show you, How to write JavaScript String Compare Function with example.

The LocaleCompare method will perform string comparison based on local language settings and returns any of the following three values:

This will return -1, if String_Object1 sorts before the String_Object2
This will return +1, if String_Object1 sorts after the String_Object2
This will return 0, if String_Object1 and String_Object2 are equal

Syntax of a JavaScript String Compare

The basic syntax of the JavaScript String Compare function is as shown below:

String_Object1.localcompare(String_Object2, locales)

String_Object1: This argument is required. Please specify the valid string to perform comparison.
String_Object2: This argument is required. Please specify the valid string to perform comparison. This argument will be compared against the String_Object1
Locales: This argument is optional. Here you can specify one or array of languages or local tag. LocaleCompare() method will consider this argument while comparing String_Object1 and String_Object1.

Example for JavaScript String Compare

The following set of examples will help you understand the LocaleCompare() function in JavaScript Programming Language.

JAVASCRIPT CODE

<!DOCTYPE html>
<html>
<head>
    <title> JavaScript String Compare </title>
</head>
<body>
    <h1> JavaScript String Comparison </h1>
<script>
    var Str1 = "abc";
    var Str2 = "def";
    var Str3 = "ghi";
    
    var Str4 = Str1.localeCompare(Str2);
    var Str5 = Str3.localeCompare(Str2);
    var Str6 = Str1.localeCompare("abc");
  
    document.write(Str4 + "<br \>");
    document.write(Str5 + "<br \>");
    document.write(Str6 + "<br \>");
</script>
</body>
</html>

OUTPUT

ANALYSIS

Within the Script tag, First we declared three String variables Str1, Str2, Str3 and assigned corresponding values using following statement

  var Str1 = "abc";
  var Str2 = "def";
  var Str3 = "ghi";

Following statement will compare the sub string ‘abc’ with ‘def’ and return the output. As we all know, ‘abc’ will come before the ‘def’ while sorting the data that’s why localeCompare method is returning -1 (Negative one)

var Str4 = Str1.localeCompare(Str2);

Following statement will compare the sub string ‘ghi’ with ‘def’ and return the output. As we all know, ‘ghi’ will come after the ‘def’ while sorting the data that’s why localeCompare method is returning 1 (Positive one)

var Str5 = Str3.localeCompare(Str2);

Following statement will compare the sub string ‘abc’ with ‘abc’ and return the output. As we all know, ‘abc’ is equal to ‘abc’ that’s why localeCompare method is returning 0 (Zero)

var Str6 = Str1.localeCompare("abc");

Thank You for Visiting Our Blog