Back to Content

URLPattern: search property

files/en-us/web/api/urlpattern/search/index.md

latest1.1 KB
Original Source

{{APIRef("URL Pattern API")}} {{AvailableInWorkers}}

The search read-only property of the {{domxref("URLPattern")}} interface is a string containing the pattern used to match the search part of a URL.

This is the normalized value of the search pattern passed to the constructor, an inherited value from a baseURL passed to the constructor, or the default value ("*"), which matches any search part.

Value

A string.

Examples

Basic usage

The following example creates a {{domxref("URLPattern")}} object with 'q=baby' for the search part and logs the property. This pattern matches any URL for which the search part includes exactly that text.

js
const pattern = new URLPattern({
  search: "q=baby",
});
console.log(pattern.search); // "q=baby"
console.log(pattern.test("https://example.com/shoes?q=baby")); // true

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}