Documentation

Filter Query

Schema-driven parser and serializer for typed URL filters and query state.

@plumile/filter-query is the deterministic URL state package. Use it with the router or independently when URL filters need typed parsing, diagnostics, and stable serialization.

Pages in this section

  • Filter Query overview - Schema-driven URL filters with typed parsing, diagnostics, mutation, and serialization.
  • Schemas - Define fields and allowed operators for URL filter state.
  • Operators - Use operator subsets to control what each field accepts.
  • Diagnostics - Inspect parse diagnostics before trusting URL input.
  • Serialization - Serialize filters back to stable query strings.
  • Router integration - Attach filter-query schemas to routes and consume typed filters from router hooks.
  • GraphQL where - Map URL filters to a GraphQL where object and back again.