QueryParamSyncOptions

Interface

projects/common/layout/router/inject-query-param-sync.ts

Info
API

Import#

import { QueryParamSyncOptions } from '@cngx/common/layout'

Description#

param accepts a live Signal<string> so a bound [param] rename stays reactive; a plain string is wrapped internally. serialize/deserialize default to a boolean codec (true -> 'open', absence -> false); pass an identity codec (v => v ?? null / raw => raw) to sync string ids.

Index#

Properties

deserialize onSyncError param serialize

Instance Properties#

deserialize#function

ReadonlyOptional

URL string (or null when absent) -> T. Default: boolean codec.

onSyncError#function

ReadonlyOptional

Invoked with the rejection reason when router.navigate rejects.

param#string | Signal

Readonly

Query-param key. A Signal<string> keeps a bound rename live.

serialize#function

ReadonlyOptional

T -> URL string, or null to remove the key. Default: boolean codec.