API 概览

API 概览

Decurl 面向应用开发者只提供 @guanriyue/decurl 这个包。

默认入口提供 React Router hooks;除此之外,还可以使用 codecdecoderouteSpecpaginationprovided 等 API 入口。

入口

入口用途
@guanriyue/decurl开箱即用的 React Router hooks
@guanriyue/decurl/codecFieldCodec、Search Fields、URLSearchParams codec
@guanriyue/decurl/decodedecode primitive 与组合工具
@guanriyue/decurl/routeSpec定义 path 与 search contract,并生成类型安全的 href
@guanriyue/decurl/paginationpage、pageSize 与分页联动行为
@guanriyue/decurl/provided使用 Provider store 的 hooks,并集中获取 React Router location / navigate

推荐阅读顺序

  1. 先读 快速开始
  2. 再读 FieldCodec 定义
  3. 然后读 Decode pipeline
  4. 继续读 Search Fields
  5. React Router 用户继续读 集成概览

Reference

@guanriyue/decurl

@guanriyue/decurl/codec

@guanriyue/decurl/decode

@guanriyue/decurl/routeSpec

@guanriyue/decurl/pagination

@guanriyue/decurl/provided