API de paramètres et de requêtes

Ces fonctions vous permettent de lire et d'écrire des paramètres ou des états d'historique par programmation.

`getPageParams`

Récupère un objet contenant tous les paramètres analysés à partir du chemin d’accès de l’URL actuel.

typescript
function getPageParams<T extends Record<string, string>>(): T

Exemple

javascript
// Browser location: /projects/marketing/dashboard
// Route pattern: /projects/:category/:tab

import { getPageParams } from '@beforesemicolon/router'

const params = getPageParams()
// Returns: { category: 'marketing', tab: 'dashboard' }

`getSearchParams`

Récupère les paramètres de requête d’URL analysés en tant qu’objet clé-valeur. Prend en charge l'analyse automatique JSON pour les objets de requête complexes.

typescript
function getSearchParams<T extends Record<string, string>>(): T

Exemple

javascript
// Browser location: /search?query=hello&tags=%5B%22js%22%2C%22web%22%5D

import { getSearchParams } from '@beforesemicolon/router'

const query = getSearchParams()
// Returns: { query: 'hello', tags: ['js', 'web'] }

Met à jour ou efface les paramètres de recherche d’URL. Les mises à jour sont effectuées sur place en utilisant le remplacement de l'historique (n'ajoute pas de nouvelle entrée à la pile arrière du navigateur).

typescript
function updateSearchQuery(searchObject: Record<string, unknown> | null): void

Transmettez null pour effacer tous les paramètres de requête de l’URL.

Exemple

javascript
import { updateSearchQuery } from '@beforesemicolon/router'

// Add page parameters to current URL
updateSearchQuery({ page: 2, filter: 'active' })
// Browser updates to: ?page=2&filter=active

// Clear queries
updateSearchQuery(null)
// Browser updates to: (query parameters removed)

`getPageData`

Récupère l’objet de charge utile de l’état actuel de l’historique.

typescript
function getPageData<T extends Record<string, unknown>>(): T

Exemple

javascript
import { getPageData } from '@beforesemicolon/router'

const data = getPageData()
console.log('User Role:', data.role)

modifier ce document