API de parámetros y consultas: Router por Before Semicolon

API de parámetros y consultas

Estas funciones le permiten leer y escribir parámetros o estados históricos mediante programación.

`getPageParams`

Recupera un objeto que contiene todos los parámetros analizados desde la ruta de acceso URL actual.

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

Ejemplo

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`

Recupera los parámetros de consulta de URL analizados como un objeto clave-valor. Admite el análisis JSON automático para objetos de consulta complejos.

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

Ejemplo

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'] }

`updateSearchQuery`

Actualiza o borra los parámetros de búsqueda de URL. Las actualizaciones se realizan in situ mediante el reemplazo del historial (no agrega una nueva entrada a la pila de actividades del navegador).

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

Pase null para borrar todos los parámetros de consulta de la URL.

Ejemplo

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`

Recupera el objeto de carga útil del estado del historial actual.

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

Ejemplo

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

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

editar este documento