app-workflow_engine

On this page:

localeCompare

Summary

Compares two strings.

Description

Returns a number indicating whether a reference string comes before or after or is the same as the given string in sort order.

Route

No Northbound API Available

Roles

admin

Parameters

DetailsExampleSchema
Name Type Required Description
referenceStr string yes The reference string to compare
compareString string yes The string against which the referring string is compared
locales string no A string with a BCP 47 language tag, or an array of such strings
options object no Options to pass

Return

DetailsExampleSchema
Name Type Description
compareResult number Negative number if the reference string occurs before the compare string; positive if the reference string occurs after the compare string; 0 if they are equivalent