lamed_test/doc/functions/compareStr.md

Mocha unit testing made easy

# Function compareStr (str1, str2, showResult, showLines)

>**compareStr**(str1, str2, showResult, showLines)
- compares two strings and return the index of difference.
- **Return {number}** - The position where the two strings differ. If the strings are the same, -1 is returned
- See [Functions](../functions.md)

## Parameters

| Parameter |Type |Default |Description |
|  ---- | ---- | ---- | ---- |
**str1** |string | |The first string to compare |
**str2** |string | |The second string to compare |
**showResult** |bool |true |If true, show where the strings differ |
**showLines** |bool |true |If true, print out extra lines |