Intl.Collator.prototype.compare

概要

このCollatorオブジェクトのソート順に応じて２つの文字列を比較するゲッター関数を返します。

構文

collator.compare(string1, string2)

引数

string1

string2

互いに対して比較する文字列

説明

compareによって返される関数はstring1とstring2がCollatorオブジェクトのソート順に応じてどのくらい互いに比較するかを指し示す数値を返します。: string1がstring2より小さい場合、マイナス値 ; string1 が string2より大きい場合、プラス値; 同じなら、0

例

例: ソート配列に対して、compareを使う

ソート配列に対してcompareによって返される関数を使ってください。Note that 関数は含まれていたcollatorにバインドされていることに注意して下さい。 というのも、Array.prototype.sort()に直接渡されるからです。

var a = ['Offenbach', 'Österreich', 'Odenwald'];
var collator = new Intl.Collator('de-u-co-phonebk');
a.sort(collator.compare);
console.log(a.join(', '));
// → "Odenwald, Österreich, Offenbach"

例: 配列の検索に対してcompareを使う

配列内の一致する文字列を見つけるためにcompareによって返される関数を使って下さい。:

var a = ['Congrès', 'congres', 'Assemblée', 'poisson'];
var collator = new Intl.Collator('fr', { usage: 'search', sensitivity: 'base' });
var s = 'congres';
var matches = a.filter(function(v) {
  return collator.compare(v, s) === 0;
});
console.log(matches.join(', '));
// → "Congrès, congres"

仕様

ブラウザ実装状況

関連情報

• Intl.Collator
• String.prototype.localeCompare()