URLSearchParams: keys() method

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

The keys() method of the {{domxref("URLSearchParams")}} interface returns an {{jsxref("Iteration_protocols",'iterator')}} allowing iteration through all keys contained in this object. The keys are strings.

Syntax

keys()

Parameters

None.

Return value

Returns an {{jsxref("Iteration_protocols","iterator")}}.

Examples

// Create a test URLSearchParams object
const searchParams = new URLSearchParams("key1=value1&key2=value2");

// Display the keys
for (const key of searchParams.keys()) {
  console.log(key);
}

The result is:

key1
key2

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• The {{domxref("URL")}} interface.