Makkelijke URL-manipulatie met URLSearchParams

De URLSearchParams-API biedt een consistente interface voor de verschillende delen van de URL en maakt eenvoudige manipulatie van de querytekenreeks mogelijk (het gedeelte na ?).

Traditioneel gebruiken ontwikkelaars regexen en tekenreekssplitsing om queryparameters uit de URL te halen. Als we eerlijk zijn, is dat niet leuk. Het kan een vervelend en foutgevoelig proces zijn om dit goed te doen. Een van mijn duistere geheimen is dat ik dezelfde get|set|removeURLParameter helpermethoden heb hergebruikt in verschillende grote Google.com-apps, waaronder de Google Santa Tracker en het Google I/O 2015-web.

Het is tijd voor een goede API die dit voor ons doet.

URLSearchParams API

Probeer de demo

Chrome 49 implementeert URLSearchParams uit de URL-specificatie, een API die handig is om te experimenteren met URL-queryparameters. Ik zie URLSearchParams als een equivalent gemak voor URL's zoals FormData dat was voor formulieren.

Wat kun je ermee doen? Met een URL-tekenreeks kunt u eenvoudig parameterwaarden extraheren:

// Can also constructor from another URLSearchParams
const params = new URLSearchParams('q=search+string&version=1&person=Eric');

params.get('q') === "search string"
params.get('version') === "1"
Array.from(params).length === 3
for (let p of params) {
    console.log(p);
}

een parameterwaarde instellen:

params.set('version', 2);

append een andere waarde voor een bestaande parameter:

params.append('person', 'Tim');
params.getAll('person') === ['Eric', 'Tim']

een of meer parameters verwijdert,

params.delete('person');

Werken met URL's

Meestal werkt u met volledige URL's of past u de URL van uw app aan. De constructor URL kan in deze gevallen bijzonder handig zijn:

const url = new URL('https://example.com?foo=1&bar=2');
const params = new URLSearchParams(url.search);
params.set('baz', 3);

params.has('baz') === true
params.toString() === 'foo=1&bar=2&baz=3'

Als u daadwerkelijke wijzigingen in de URL wilt aanbrengen, kunt u parameters ophalen, de waarden updaten en daarna history.replaceState gebruiken om de URL te updaten.

// URL: https://example.com?version=1.0
const params = new URLSearchParams(location.search);
params.set('version', 2.0);

window.history.replaceState({}, '', `${location.pathname}?${params}`);
// URL: https://example.com?version=2.0

Hier heb ik ES6-templatereeksen gebruikt om een geüpdatete URL te reconstrueren op basis van het bestaande URL-pad van de app en de aangepaste parameters.

Integratie met andere plaatsen waar URL's worden gebruikt

Als je FormData stuurt in een fetch() API-verzoek, wordt er standaard een multipart-body gemaakt. Als je dit nodig hebt, biedt URLSearchParams een alternatief mechanisme om gegevens te POSTEN die urlencoded zijn in plaats van mime multipart.

const params = new URLSearchParams();
params.append('api_key', '1234567890');

fetch('https://example.com/api', {
    method: 'POST',
    body: params
}).then(...)

Hoewel het nog niet is geïmplementeerd in Chrome, is URLSearchParams ook geïntegreerd met de URL-constructor en a-tags. Beide ondersteunen onze nieuwe buddy door een alleen-lezen property te bieden, .searchParams, voor toegang tot queryparameters:

const url = new URL(location);
const foo = url.searchParams.get('foo') || 'somedefault';

Links krijgen ook een .searchParams-property:

const a = document.createElement('a');
a.href = 'https://example.com?filter=api';

// a.searchParams.get('filter') === 'api';

Functiedetectie en browserondersteuning

Op dit moment ondersteunen Chrome 49, Firefox 44 en Opera 36 URLSearchParams.

if ('URLSearchParams' in window) {
    // Browser supports URLSearchParams
}

Voor polyfills raad ik die op github.com/WebReflection/url-search-params aan.

Demo

Probeer het voorbeeld.

Als je URLSearchParams in een echte app wilt zien, ga je naar de Iconset Generator voor Material Design van Polymer. Ik heb het gebruikt om de begintoestand van de app in te stellen via een deep link. Heel handig :)