JavaScript / コードを試す
Array.prototype.filter()
filter() は関数の戻り値が truthy になる要素を、新しい配列へ集めます。コールバックによる元配列の変更、オブジェクトの共有、空配列や穴の扱いも実行して確かめます。
固定例はNode 24.22.3の実行記録を照合しています()。下の入力欄の結果は今回の実行で確認してください。
コードを編集して試す
ブラウザー内で実行します。コードの送信・自動実行・自動保存はしません。このタブを閉じると入力は失われます。機密情報は入力しないでください。
8,192 UTF-8 byte・実行1.5秒・出力60行/8KiB以内。Ctrl / ⌘ + Enterでも実行できます。
パネルを開くと編集できます。
現在の入力は未実行です。
入力中のコードをこの例へ置き換えます。
実行画面や検索画面の間の通常クリックでは入力をこのタブのRAMで保持します。元の教材は別タブで開きます。再読み込み・タブ終了ではRAMの入力は失われます。
filter() は、配列の要素を関数に通し、戻り値がtruthyになる要素を集めた新しい配列を返します。条件に合うデータだけを取り出したいときに使います。
filter() 自体は元の配列へ代入しませんが、コールバックによる変更や、要素のオブジェクトの共有は可能です。
const nums = [1, 2, 3, 4, 5]; const even = nums.filter(n => n % 2 === 0); console.log(even); console.log(nums);
[ 2, 4 ] [ 1, 2, 3, 4, 5 ]
上のコードは書き換えて実行できます。n % 2 === 0 を n > 3 にしてみてください。
何が返るのか
| 中身 | |
|---|---|
| 戻り値 | 通常の配列では新しい配列。長さは開始時の長さ以下 |
| 元の配列 | 自身は代入しない。コールバックによる変更は可能 |
| 呼ばれる位置 | 開始時の長さの範囲で、訪問時に存在する添字 |
| 1つも通らなかったとき | 空配列(null ではない) |
filter() は非破壊的メソッドに分類されます。渡した関数まで副作用がない、という保証ではありません。コールバックが例外を投げれば処理は中断し、その例外が呼び出し元へ伝わります。
1つも通らなくても null にならない
見つからなかったときに null や undefined が返ると思って書くと、そこで詰まります。
通常の配列で正常に完了した場合は、1件も一致しなくても配列が返ります。
const nums = [1, 3, 5]; const even = nums.filter(n => n % 2 === 0); console.log(even); console.log(even.length); console.log(even.length === 0);
[] 0 true
判定は if (even) ではなく even.length === 0 で書きます。
空配列は truthy です。if (even) は必ず通ってしまいます。
コールバック関数が受け取るもの
構文は array.filter(callback, thisArg) です。関数でない値を callback に渡すと TypeError になります。
map() と同じで、3つの引数が渡されます。
const chars = ['a', 'b', 'c', 'd']; const picked = chars.filter((value, index, array) => { return index % 2 === 0 && array.length === 4; }); console.log(picked);
[ 'a', 'c' ]
省略可能な thisArg は通常の関数の this に渡されます。アロー関数の this は外側で決まり、thisArg では変わりません。
真偽値でなくてもよい(truthy / falsy で判定される)
戻り値は true / false でなくて構いません。truthyなら残り、falsyなら落ちます。
この性質を使うと、falsyな値をまとめて除く書き方ができます。
const messy = ['a', '', 'b', 0, null, 'c', undefined, NaN]; console.log(messy.filter(Boolean));
[ 'a', 'b', 'c' ]
filter(Boolean) は「falsy を全部落とす」という意味になります。
false / 0 / -0 / 0n / 空文字 / null / undefined / NaN はfalsyです。0も有効なデータなら、filter(Boolean)で除去しない条件を書いてください。
よくある間違い
値を返してしまう
filter() に渡すのは残すかどうかの判定です。値を返すと、その値が truthy かどうかで判定されます。
const nums = [0, 1, 2, 3];
const picked = nums.filter(n => n);
console.log(picked);[ 1, 2, 3 ]
0 が意図せず落ちました。n を残したいのではなく n が falsy かどうかを見ています。
値を変換したいときは filter() ではなく map() を使います。
1件だけ欲しいのに filter を使う
先頭の1件だけが欲しいなら find() です。
filter() は一致があっても止まらず、開始時の長さの範囲を最後まで調べます。例外で中断する場合は別です。
const users = [ { id: 1, name: 'あかり' }, { id: 2, name: 'ゆうと' }, { id: 3, name: 'ゆうと' }, ]; console.log(users.filter(u => u.name === 'ゆうと')); console.log(users.find(u => u.name === 'ゆうと'));
[ { id: 2, name: 'ゆうと' }, { id: 3, name: 'ゆうと' } ]
{ id: 2, name: 'ゆうと' }| 戻り値 | 見つからないとき | どこまで見るか | |
|---|---|---|---|
filter() |
配列 | 空配列 | 最後まで |
find() |
要素そのもの | undefined |
見つかった時点で止まる |
find() が undefined を返したことに気づかず、そのままプロパティを読むと
Cannot read properties of undefined
になります。空振りしたときにどうするかを、その場で決めてください。
穴のあいた配列では、穴が消える
配列自身にもプロトタイプ上にも添字が存在しない位置(疎な配列の穴)ではコールバック関数が呼ばれません。
そして結果の配列に穴は残りません。ここが map() と違います。
const sparse = [1, , 3]; console.log(sparse.map(n => n)); console.log(sparse.filter(() => true)); console.log(sparse.filter(() => true).length);
[ 1, <1 empty item>, 3 ] [ 1, 3 ] 2
map() は長さを保つので穴がそのまま残り、filter() は通ったものを詰め直すので穴が消えます。
出力は当サイトの共通整形器による表示です。ブラウザー開発者ツールの見た目とは異なる場合があります。
継承した添字があれば、その値は処理されます。次の例は専用の親オブジェクトだけを作り、共有の Array.prototype は変更しません。
const values = [1, , 3]; const parent = Object.create(Array.prototype); parent[1] = 2; Object.setPrototypeOf(values, parent); console.log(values.filter(() => true));
[ 1, 2, 3 ]
新しい配列でも、中のオブジェクトは共有される
配列の入れ物は別でも、要素のオブジェクトは同じものを指します。結果側でプロパティを変えると、元の配列から見える値も変わります。
const users = [{ name: 'あかり', active: true }]; const selected = users.filter(user => user.active); selected[0].name = 'ひかり'; console.log(selected === users); console.log(selected[0] === users[0]); console.log(users[0].name);
false true ひかり
途中で元の配列を変えない
コールバックへ渡される値は、その位置を訪問した時点で読み取られます。その後で同じ位置へ代入しても、すでに読み取った数値は差し替わりません。次は挙動を確かめるための失敗例です。
const nums = [1, 2, 3];
const selected = nums.filter((value, index, array) => {
array[index] = value * 10;
return true;
});
console.log(selected);
console.log(nums);[ 1, 2, 3 ] [ 10, 20, 30 ]
要素を書き換えたいなら、判定の中で元データを更新せず、map()で変換後の値を返します。
filter() は走り始めた時点の長さを覚えています。その範囲より後ろへ追加した要素は見に行きません。
const nums = [1, 2, 3];
const result = nums.filter((n) => {
nums.push(n * 10);
return true;
});
console.log(result);
console.log(nums.length);[ 1, 2, 3 ] 6
元の配列は6件に増えたのに、結果は3件のままです。
ループの中で元の配列を変えない。これは map() でも forEach() でも同じです。
未訪問の要素を変えれば変更後の値を読み、未訪問の添字を削除すればそこを飛ばします。変更・削除・末尾追加を同時に行うと、結果は次のようになります。
const nums = [1, 2, 3];
const selected = nums.filter((value, index, array) => {
if (index === 0) {
array[1] = 20;
delete array[2];
array.push(4);
}
return true;
});
console.log(selected);
console.log(nums);[ 1, 20 ] [ 1, 20, <1 empty item>, 4 ]
このような副作用を判定に混ぜず、元配列を読む処理と更新する処理を分けます。