node-lib

@wtasnorg/node-lib


@wtasnorg/node-lib / compareString

Function: compareString()

compareString(a, b): number

Defined in: src/strings.ts:148

Compare returns an integer comparing two strings lexicographically. The result will be 0 if a === b, -1 if a < b, and +1 if a > b.

Parameters

a

string

First string.

b

string

Second string.

Returns

number

-1, 0, or 1.

Example

compare("a", "b"); // -1
compare("b", "a"); // 1
compare("a", "a"); // 0