Array.prototype.filter()
Baseline
Weitgehend verfügbar
Diese Funktion ist gut etabliert und funktioniert auf vielen Geräten und in vielen Browserversionen. Sie ist seit Juli 2015 browserübergreifend verfügbar.
Die filter() Methode von Array Instanzen erstellt eine flache Kopie eines Teils eines gegebenen Arrays, gefiltert auf die Elemente, die den Test bestehen, der von der bereitgestellten Funktion implementiert wurde.
Probieren Sie es aus
const words = ["spray", "elite", "exuberant", "destruction", "present"];
const result = words.filter((word) => word.length > 6);
console.log(result);
// Expected output: Array ["exuberant", "destruction", "present"]
Syntax
filter(callbackFn)
filter(callbackFn, thisArg)
Parameter
callbackFn-
Eine Funktion, die für jedes Element im Array ausgeführt wird. Sie sollte einen truthy Wert zurückgeben, um das Element im resultierenden Array zu behalten, und einen falsy Wert andernfalls. Die Funktion wird mit den folgenden Argumenten aufgerufen:
thisArgOptional-
Ein Wert, der als
thisverwendet wird, wenncallbackFnausgeführt wird. Siehe iterative Methoden.
Rückgabewert
Eine flache Kopie des gegebenen Arrays, die nur die Elemente enthält, die den Test bestehen. Wenn keine Elemente den Test bestehen, wird ein leeres Array zurückgegeben.
Beschreibung
Die filter() Methode ist eine iterative Methode. Sie ruft die bereitgestellte callbackFn Funktion einmal für jedes Element in einem Array auf und konstruiert ein neues Array mit allen Werten, für die callbackFn einen truthy Wert zurückgibt. Array-Elemente, die den callbackFn Test nicht bestehen, werden im neuen Array nicht aufgenommen. Lesen Sie den Abschnitt über iterative Methoden, um mehr darüber zu erfahren, wie diese Methoden im Allgemeinen funktionieren.
callbackFn wird nur für Array-Indizes aufgerufen, denen Werte zugewiesen wurden. Für leere Plätze in spärlichen Arrays wird es nicht aufgerufen.
Die filter() Methode ist generisch. Sie erwartet nur, dass der this Wert eine length Eigenschaft und integer-basierte Eigenschaften hat.
Beispiele
Herausfiltern aller kleinen Werte
Das folgende Beispiel verwendet filter(), um ein gefiltertes Array zu erstellen, das alle Elemente mit Werten kleiner als 10 entfernt.
function isBigEnough(value) {
return value >= 10;
}
const filtered = [12, 5, 8, 130, 44].filter(isBigEnough);
// filtered is [12, 130, 44]
Finden aller Primzahlen in einem Array
Das folgende Beispiel gibt alle Primzahlen im Array zurück:
const array = [-3, -2, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13];
function isPrime(n) {
if (n < 2) {
return false;
}
if (n % 2 === 0) {
return n === 2;
}
for (let factor = 3; factor * factor <= n; factor += 2) {
if (n % factor === 0) {
return false;
}
}
return true;
}
console.log(array.filter(isPrime)); // [2, 3, 5, 7, 11, 13]
Hinweis:
Die Implementierung von isPrime() dient nur als Demonstration. Für eine reale Anwendung sollten Sie einen stark memoisierten Algorithmus wie den Sieb des Eratosthenes verwenden, um wiederholte Berechnungen zu vermeiden.
Filtern ungültiger Objekte aus einem Array von Objekten
Das folgende Beispiel verwendet filter(), um ein gefiltertes Array aller Objekte mit nicht-null, numerischer id zu erstellen.
const arr = [
{ id: 15 },
{ id: -1 },
{ id: 0 },
{ id: 3 },
{ id: 12.2 },
{},
{ id: null },
{ id: NaN },
{ id: "undefined" },
];
let invalidEntries = 0;
function filterByID(item) {
if (Number.isFinite(item.id) && item.id !== 0) {
return true;
}
invalidEntries++;
return false;
}
const arrByID = arr.filter(filterByID);
console.log("Filtered Array\n", arrByID);
// Filtered Array
// [{ id: 15 }, { id: -1 }, { id: 3 }, { id: 12.2 }]
console.log("Number of Invalid Entries =", invalidEntries);
// Number of Invalid Entries = 5
Suche im Array
Das folgende Beispiel verwendet filter(), um Array-Inhalte basierend auf Suchkriterien zu filtern.
const fruits = ["apple", "banana", "grapes", "mango", "orange"];
/**
* Filter array items based on search criteria (query)
*/
function filterItems(arr, query) {
return arr.filter((el) => el.toLowerCase().includes(query.toLowerCase()));
}
console.log(filterItems(fruits, "ap")); // ['apple', 'grapes']
console.log(filterItems(fruits, "an")); // ['banana', 'mango', 'orange']
Verwenden des dritten Parameters von callbackFn
Das array-Argument ist nützlich, wenn Sie auf ein anderes Element im Array zugreifen möchten, insbesondere wenn keine vorhandene Variable auf das Array verweist. Das folgende Beispiel verwendet zuerst map(), um die numerische ID aus jedem Namen zu extrahieren, und dann filter(), um diejenigen auszuwählen, die größer sind als ihre Nachbarn.
const names = ["JC63", "Bob132", "Ursula89", "Ben96"];
const greatIDs = names
.map((name) => parseInt(name.match(/\d+/)[0], 10))
.filter((id, idx, arr) => {
// Without the arr argument, there's no way to easily access the
// intermediate array without saving it to a variable.
if (idx > 0 && id <= arr[idx - 1]) return false;
if (idx < arr.length - 1 && id <= arr[idx + 1]) return false;
return true;
});
console.log(greatIDs); // [132, 96]
Das array-Argument ist nicht das Array, das erstellt wird – es gibt keine Möglichkeit, vom Rückruffunktion aus auf das erstellte Array zuzugreifen.
Verwenden von filter() auf spärlichen Arrays
filter() überspringt leere Plätze.
console.log([1, , undefined].filter((x) => x === undefined)); // [undefined]
console.log([1, , undefined].filter((x) => x !== 2)); // [1, undefined]
Aufrufen von filter() bei Nicht-Array-Objekten
Die filter() Methode liest die length Eigenschaft von this und greift dann auf jede Eigenschaft zu, deren Schlüssel eine nicht-negative Ganzzahl kleiner als length ist.
const arrayLike = {
length: 3,
0: "a",
1: "b",
2: "c",
3: "a", // ignored by filter() since length is 3
};
console.log(Array.prototype.filter.call(arrayLike, (x) => x <= "b"));
// [ 'a', 'b' ]
Spezifikationen
| Spezifikation |
|---|
| ECMAScript® 2027 Language Specification # sec-array.prototype.filter |