SearchParams<S> class final

A bidirectional typed search-state contract.

Constructors

SearchParams.codec({required Iterable<String> keys, required S defaults, required S decode(SearchInput input), required void encode(S value, SearchOutput output), InvalidSearchBehavior invalid = InvalidSearchBehavior.fallback})
Creates an explicit runtime codec.
factory
SearchParams.schema({required S defaults, InvalidSearchBehavior invalid = InvalidSearchBehavior.fallback})
Declares a codec that the file-route compiler must generate.
const

Properties

defaults → S
The complete state used when the URL omits or invalidates values.
final
hashCode → int
The hash code for this object.
no setterinherited
invalid → InvalidSearchBehavior
The invalid-value policy.
final
isSchema → bool
Whether this contract still requires file-route compilation.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

decode(Map<String, List<String>> values) → DecodedSearch<S>
Decodes a URI query multimap into canonical typed state.
encode(S value) → Map<String, List<String>>
Encodes typed state into a canonical URI query multimap.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited