URLPattern: exec()-Methode

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig vor der Verwendung auf produktiven Webseiten.

Hinweis: Diese Funktion ist in Web Workers verfügbar.

Die exec()-Methode der URLPattern-Schnittstelle nimmt eine URL oder ein Objekt von URL-Teilen und gibt entweder ein Objekt zurück, das die Ergebnisse des Abgleichs der URL mit dem Muster enthält, oder null, wenn die URL nicht mit dem Muster übereinstimmt.

Syntax

js
exec(input)
exec(input, baseURL)

Parameter

input

Die URL oder die URL-Teile, die verglichen werden sollen. Dies kann entweder ein String oder ein Objekt sein, das die einzelnen URL-Teile bereitstellt. Die Objektmitglieder können protocol, username, password, hostname, port, pathname, search, hash oder baseURL sein. Ausgelassene Teile im Objekt werden als leere Strings behandelt. Wenn die Eingabe nicht geparst werden kann oder eine relative URL ohne Basis angegeben wird, gibt die Methode null zurück.

baseURL Optional

Ein String, der die Basis-URL darstellt, die in Fällen verwendet wird, in denen input eine relative URL ist. Wird dieser Wert nicht angegeben, wird er standardmäßig auf undefined gesetzt. Wenn dieser Parameter nicht geparst werden kann, gibt die Methode null zurück.

Rückgabewert

Ein object mit einem inputs-Schlüssel, der das Array der an die Funktion übergebenen Argumente enthält, sowie Schlüsseln für jeden der URL-Teile, die die übereinstimmende Eingabe und die übereinstimmenden Gruppen für diesen Teil enthalten.

Beispiele

Dieses Beispiel zeigt, wie die exec()-Methode verwendet wird, um eine URL mit einem Muster abzugleichen. Das Beispiel gibt das Ergebnis der exec()-Aufrufe in der Konsole aus.

js
const pattern = new URLPattern("http{s}?://*.example.com/books/:id");

// Absolute URL strings
console.log(pattern.exec("https://example.com/books/123")); // null
let match = pattern.exec("https://store.example.com/books/123");
console.log(match.inputs); // ['https://store.example.com/books/123']
console.log(match.protocol); // { input: "https", groups: {} }
console.log(match.username); // { input: "", groups: {} }
console.log(match.password); // { input: "", groups: {} }
console.log(match.hostname); // { input: "store.example.com", groups: { "0": "store" } }
console.log(match.port); // { input: "", groups: {} }
console.log(match.pathname); // { input: "/books/123", groups: { "id": "123" } }
console.log(match.search); // { input: "", groups: {} }
console.log(match.hash); // { input: "", groups: {} }

// Relative URL strings
pattern.exec("/books/123", "http://store.example.com"); // returns object
pattern.exec("/books/123", "data:text/plain,hello world!"); // returns object
pattern.exec("/books/123"); // returns null

// Structured objects
pattern.exec({
  pathname: "/books/123",
  baseURL: "http://store.example.com",
}); // returns object
pattern.exec({
  protocol: "https",
  hostname: "store.example.com",
  pathname: "/books/123",
}); // returns object
pattern.exec({
  protocol: "file",
  hostname: "store.example.com",
  pathname: "/books/123",
}); // returns null

Spezifikationen

Specification
URL Pattern Standard
# dom-urlpattern-exec

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch

  • Ein Polyfill von URLPattern ist verfügbar auf GitHub