API Reference

---

API Reference / @dasch-ng/route-signals / BindQuerySignalOptions

Interface: BindQuerySignalOptions<T>

Defined in: bind-query-signal.ts:9

Type Parameters

T

T

Properties

defaultValue

defaultValue: T

Defined in: bind-query-signal.ts:18

The value considered "unset". A value that serializes like defaultValue removes the parameter from the URL instead of writing it out.

---

deserialize?

optional deserialize?: (raw) => T

Defined in: bind-query-signal.ts:25

URL string to value. Defaults to returning the raw string; override for numbers, dates, objects.

Parameters

raw

string

Returns

T

---

param

param: string

Defined in: bind-query-signal.ts:13

Query parameter name used in the URL.

---

serialize?

optional serialize?: (value) => string | null

Defined in: bind-query-signal.ts:23

Value to URL string. Defaults to String(value), with null/undefined removing the parameter. Return null to remove the parameter for other values too.

Parameters

value

T

Returns

string | null

---

signal

signal: WritableSignal<T>

Defined in: bind-query-signal.ts:11

The writable signal whose value is mirrored into the URL.