Wow

中文

English

中文

English

外观

wow-react 查询 Hook ​

Wow Hook 为同一个查询执行器限定请求/结果类型，不替你创建客户端或构建条件。服务版本要求 execute 函数，Fetcher 版本要求 url，可选命名或实例 Fetcher。

服务 HookFetcher Hook请求 → 结果
useSingleQueryuseFetcherSingleQuerySingleQueryRequest → R
useListQueryuseFetcherListQueryListQueryRequest → R[]
usePagedQueryuseFetcherPagedQueryPagedQueryRequest → PagedList<R>，含 total/list
useCountQueryuseFetcherCountQueryFilterExpression 或旧版 Condition → number
useListStreamQueryuseFetcherListStreamQueryListQueryRequest → 随到随增的 items: R[]

查询类型默认为 FilterSingleQuery、FilterListQuery、FilterPagedQuery 或 FilterExpression。每个 Hook 另有一个重载接受从 @ahoo-wang/wow-client/legacy 导入的已弃用 Condition 查询，供 Wow 8.10 服务端使用，该重载在 v10 移除。下文签名中的 SingleQueryRequest、ListQueryRequest、PagedQueryRequest 是两类查询的联合类型，同样由 /legacy 导出。FIELDS 仅在编译期约束字段名，泛型不校验服务端 JSON。对应 Use…Options、Use…Return 继承 查询状态，Fetcher 变体还继承 Fetcher 选项。默认 autoExecute true、propagateError false，没有传入就没有初始查询。Fetcher 变体把查询 POST 到 url 并按 JSON 提取；流版本发送 Accept: text/event-stream，并用 wow-client 的 QueryEventStreamResultExtractor 读取响应。

新的查询会中止进行中的查询，迟到的响应不会覆盖更新的结果；组件卸载时同样会中止。把 controller 传给服务客户端，中止时才能真正停止 I/O：wow-client 每个查询方法的最后一个参数 abort 接受 AbortController 或其 signal。请求失败时 error 是 fetcher 的错误（ExchangeError），用 @ahoo-wang/wow-client 的 await toWowError(error) 可从中读出 errorCode、errorMsg 和 status。

列表流 ​

useListStreamQuery 与 useFetcherListStreamQuery 自己持有流：读取流，把每个事件的 data 收进 items，并在新查询开始、调用 abort() 或 reset()、组件卸载时取消流。组件只渲染 items，从不持有 reader，因此在 StrictMode 下也安全；渲染按网络分块批量进行，而不是每行一次。它们不返回 result，而是返回：

字段含义
items当前查询至今收到的行，按到达顺序排列。新查询从空列表开始，reset() 清空它，abort() 或出错时保留此前已收到的行。
done流正常结束，items 已包含全部行；等同于 status === 'success'。
loading从发出请求到流结束、失败或被中止。
error请求失败时为 FetcherError；服务端在流中发出错误事件时为带 errorCode 的 WowError。E 默认为 FetcherError | WowError。
status、execute、abort、reset、getQuery、setQuery与其他 Hook 相同；execute() 重新执行当前查询并中止进行中的流，reset() 停止流并清空 items。

onSuccess 在流结束后收到全部行。useListStreamQuery 的 execute 选项是 ListStreamExecutor：(query, attributes?, abortController?)，返回解析为 ReadableStream<JsonServerSentEvent<R>> 的 Promise，例如查询客户端的 listStateStream。useFetcherListStreamQuery 改为接收 url 和可选的 fetcher，没有 execute 或 resultExtractor 选项。

配合查询客户端 ​

查询客户端的方法（wow-client 的 SnapshotQueryClient，或生成的 …QueryClientFactory 通过 createSnapshotQueryClient(...) 创建的客户端）本身就是 execute 所需的 (query, attributes, abort) 形状。直接转交即可：execute: (query, attributes, abortController) => client.pagedState(query, attributes, abortController)，这样不必手写 URL，中止时也会取消请求。正因如此，没有为每个客户端单独提供 Hook：每个客户端方法配一个 Hook 只会成倍扩大公开 API，而带来的能力 execute 选项已经具备。

只有端点 URL 时再用 useFetcher*Query Hook。快照端点的形式是 order/snapshot/paged/state（不是 snapshot_state/paged），过滤状态字段写成 state.status（不是 status），因为快照查询过滤的是快照文档，聚合状态位于其 state 下。

安装 ​

需要 React 19.3 或更高版本（peer react ^19.3.0）。本包用 React Compiler 构建，产物导入 react/compiler-runtime，只有 React 19 提供它；不支持 React 18。

sh
pnpm add react react-dom @ahoo-wang/fetcher @ahoo-wang/fetcher-eventstream \
  @ahoo-wang/fetcher-react @ahoo-wang/wow-client @ahoo-wang/wow-react

需要 @ahoo-wang/fetcher-react 5.1.3 或更高版本（peer 范围 ^5.1.3 || ^6）：这些 Hook 只从 @ahoo-wang/fetcher-react/core 和 @ahoo-wang/fetcher-react/fetcher 两个子路径导入，因此不会装上 @ahoo-wang/fetcher-wow。@ahoo-wang/fetcher-react 自身又把 react-dom ^19.3.0、@ahoo-wang/fetcher-cosec、@ahoo-wang/fetcher-storage 和 @ahoo-wang/fetcher-eventbus 声明为 peer；npm 7+ 与 pnpm 8+ 会自动安装 peer，Yarn 用户需把它们加进安装命令。@ahoo-wang/wow-client 必须与 @ahoo-wang/wow-react 处于同一个小版本。包声明 Node >=22.12.0。这些 Hook 原来是 @ahoo-wang/fetcher-react 里的 Wow Hook，参见迁移指南。

完整示例 ​

tsx
import { usePagedQuery } from '@ahoo-wang/wow-react';
import {
  SnapshotQueryClient,
  pagedQuery,
  filter,
} from '@ahoo-wang/wow-client';
interface User {
  id: string;
  name: string;
}
const client = new SnapshotQueryClient<User>({ basePath: '/users' });
export function Users() {
  const query = usePagedQuery<User>({
    initialQuery: pagedQuery({ filter: filter.matchAll() }),
    execute: (request, attributes, controller) =>
      client.pagedState(request, attributes, controller),
  });
  return (
    <section>
      {query.error && <p role="alert">{query.error.message}</p>}
      <p>{query.result?.total ?? 0}</p>
      {query.result?.list.map(user => (
        <p key={user.id}>{user.name}</p>
      ))}
    </section>
  );
}

列表流随行到达随时渲染：

tsx
import { useListStreamQuery } from '@ahoo-wang/wow-react';
import {
  filter,
  listQuery,
  type SnapshotQueryClient,
} from '@ahoo-wang/wow-client';
interface OrderState {
  id: string;
  status: string;
}
export function PaidOrders({
  client,
}: {
  client: SnapshotQueryClient<OrderState>;
}) {
  const { items, done, loading, error, abort } = useListStreamQuery<OrderState>(
    {
      initialQuery: listQuery({ filter: filter.eq('state.status', 'PAID') }),
      execute: (query, attributes, abortController) =>
        client.listStateStream(query, attributes, abortController),
    },
  );
  if (error) return <p role="alert">{error.message}</p>;
  return (
    <>
      <ul>
        {items.map(order => (
          <li key={order.id}>{order.id}</li>
        ))}
      </ul>
      {loading && <button onClick={abort}>Stop</button>}
      {done && <p>{items.length} orders</p>}
    </>
  );
}

只有端点 URL 时，useFetcherListStreamQuery<OrderState>({ url: 'order/snapshot/list/state', initialQuery }) 返回同样的字段。

示例中的服务 URL 需要应用实现；类型检查不代表已经访问外部服务。

公开签名与类型 ​

以下签名按当前根入口可达声明核对。? 表示可省略；泛型/接口只约束编译期，UseQueryOptions 等继承类型可从 fetcher-react 符号索引 定位，查询类型可从 wow-client 符号索引 定位；Condition、SingleQuery、ListQuery、PagedQuery 和各 …QueryRequest 联合类型来自 @ahoo-wang/wow-client/legacy。运行时默认值和失败行为以本页上文为准。

useFetcherCountQuery ​

ts
export function useFetcherCountQuery<
  FIELDS extends string = string,
  E = FetcherError,
>(
  options: UseFetcherCountQueryOptions<FIELDS, E, FilterExpression<FIELDS>>,
): UseFetcherCountQueryReturn<FIELDS, E, FilterExpression<FIELDS>>;

typescript/wow-react/src/fetcher/useFetcherCountQuery.ts:89

ts
export function useFetcherCountQuery<
  FIELDS extends string = string,
  E = FetcherError,
>(
  options: UseFetcherCountQueryOptions<FIELDS, E, Condition<FIELDS>>,
): UseFetcherCountQueryReturn<FIELDS, E, Condition<FIELDS>>;

typescript/wow-react/src/fetcher/useFetcherCountQuery.ts:95

ts
export function useFetcherCountQuery<
  FIELDS extends string = string,
  E = FetcherError,
  Q extends Condition<FIELDS> | FilterExpression<FIELDS> =
    FilterExpression<FIELDS>,
>(
  options: UseFetcherCountQueryOptions<FIELDS, E, Q>,
): UseFetcherCountQueryReturn<FIELDS, E, Q>;

typescript/wow-react/src/fetcher/useFetcherCountQuery.ts:101

UseFetcherCountQueryOptions ​

ts
export interface UseFetcherCountQueryOptions<
  FIELDS extends string = string,
  E = FetcherError,
  Q extends Condition<FIELDS> | FilterExpression<FIELDS> =
    FilterExpression<FIELDS>,
> extends UseFetcherQueryOptions<Q, number, E> {}

typescript/wow-react/src/fetcher/useFetcherCountQuery.ts:31

UseFetcherCountQueryReturn ​

ts
export interface UseFetcherCountQueryReturn<
  FIELDS extends string = string,
  E = FetcherError,
  Q extends Condition<FIELDS> | FilterExpression<FIELDS> =
    FilterExpression<FIELDS>,
> extends UseQueryReturn<Q, number, E> {}

typescript/wow-react/src/fetcher/useFetcherCountQuery.ts:47

useFetcherListQuery ​

ts
export function useFetcherListQuery<
  R,
  FIELDS extends string = string,
  E = FetcherError,
>(
  options: UseFetcherListQueryOptions<R, FIELDS, E, FilterListQuery<FIELDS>>,
): UseFetcherListQueryReturn<R, FIELDS, E, FilterListQuery<FIELDS>>;

typescript/wow-react/src/fetcher/useFetcherListQuery.ts:98

ts
export function useFetcherListQuery<
  R,
  FIELDS extends string = string,
  E = FetcherError,
>(
  options: UseFetcherListQueryOptions<R, FIELDS, E, ListQuery<FIELDS>>,
): UseFetcherListQueryReturn<R, FIELDS, E, ListQuery<FIELDS>>;

typescript/wow-react/src/fetcher/useFetcherListQuery.ts:105

ts
export function useFetcherListQuery<
  R,
  FIELDS extends string = string,
  E = FetcherError,
  Q extends ListQueryRequest<FIELDS> = FilterListQuery<FIELDS>,
>(
  options: UseFetcherListQueryOptions<R, FIELDS, E, Q>,
): UseFetcherListQueryReturn<R, FIELDS, E, Q>;

typescript/wow-react/src/fetcher/useFetcherListQuery.ts:112

UseFetcherListQueryOptions ​

ts
export interface UseFetcherListQueryOptions<
  R,
  FIELDS extends string = string,
  E = FetcherError,
  Q extends ListQueryRequest<FIELDS> = FilterListQuery<FIELDS>,
> extends UseFetcherQueryOptions<Q, R[], E> {}

typescript/wow-react/src/fetcher/useFetcherListQuery.ts:30

UseFetcherListQueryReturn ​

ts
export interface UseFetcherListQueryReturn<
  R,
  FIELDS extends string = string,
  E = FetcherError,
  Q extends ListQueryRequest<FIELDS> = FilterListQuery<FIELDS>,
> extends UseQueryReturn<Q, R[], E> {}

typescript/wow-react/src/fetcher/useFetcherListQuery.ts:45

useFetcherListStreamQuery ​

ts
export function useFetcherListStreamQuery<
  R,
  FIELDS extends string = string,
  E = FetcherError | WowError,
>(
  options: UseFetcherListStreamQueryOptions<
    R,
    FIELDS,
    E,
    FilterListQuery<FIELDS>
  >,
): UseFetcherListStreamQueryReturn<R, FIELDS, E, FilterListQuery<FIELDS>>;

typescript/wow-react/src/fetcher/useFetcherListStreamQuery.ts:97

ts
export function useFetcherListStreamQuery<
  R,
  FIELDS extends string = string,
  E = FetcherError | WowError,
>(
  options: UseFetcherListStreamQueryOptions<R, FIELDS, E, ListQuery<FIELDS>>,
): UseFetcherListStreamQueryReturn<R, FIELDS, E, ListQuery<FIELDS>>;

typescript/wow-react/src/fetcher/useFetcherListStreamQuery.ts:109

ts
export function useFetcherListStreamQuery<
  R,
  FIELDS extends string = string,
  E = FetcherError | WowError,
  Q extends ListQueryRequest<FIELDS> = FilterListQuery<FIELDS>,
>(
  options: UseFetcherListStreamQueryOptions<R, FIELDS, E, Q>,
): UseFetcherListStreamQueryReturn<R, FIELDS, E, Q>;

typescript/wow-react/src/fetcher/useFetcherListStreamQuery.ts:116

UseFetcherListStreamQueryOptions ​

ts
export interface UseFetcherListStreamQueryOptions<
  R,
  FIELDS extends string = string,
  E = FetcherError | WowError,
  Q extends ListQueryRequest<FIELDS> = FilterListQuery<FIELDS>,
>
  extends
    Omit<UseListStreamQueryOptions<R, FIELDS, E, Q>, 'execute'>,
    FetcherCapable {
  /**
   * The list endpoint, resolved against the Fetcher's `baseURL`: for example
   * `order/snapshot/list/state` for the states of an `order` aggregate.
   */
  url: string;
}

typescript/wow-react/src/fetcher/useFetcherListStreamQuery.ts:37

UseFetcherListStreamQueryReturn ​

ts
export interface UseFetcherListStreamQueryReturn<
  R,
  FIELDS extends string = string,
  E = FetcherError | WowError,
  Q extends ListQueryRequest<FIELDS> = FilterListQuery<FIELDS>,
> extends UseListStreamQueryReturn<R, FIELDS, E, Q> {}

typescript/wow-react/src/fetcher/useFetcherListStreamQuery.ts:57

useFetcherPagedQuery ​

ts
export function useFetcherPagedQuery<
  R,
  FIELDS extends string = string,
  E = FetcherError,
>(
  options: UseFetcherPagedQueryOptions<R, FIELDS, E, FilterPagedQuery<FIELDS>>,
): UseFetcherPagedQueryReturn<R, FIELDS, E, FilterPagedQuery<FIELDS>>;

typescript/wow-react/src/fetcher/useFetcherPagedQuery.ts:99

ts
export function useFetcherPagedQuery<
  R,
  FIELDS extends string = string,
  E = FetcherError,
>(
  options: UseFetcherPagedQueryOptions<R, FIELDS, E, PagedQuery<FIELDS>>,
): UseFetcherPagedQueryReturn<R, FIELDS, E, PagedQuery<FIELDS>>;

typescript/wow-react/src/fetcher/useFetcherPagedQuery.ts:106

ts
export function useFetcherPagedQuery<
  R,
  FIELDS extends string = string,
  E = FetcherError,
  Q extends PagedQueryRequest<FIELDS> = FilterPagedQuery<FIELDS>,
>(
  options: UseFetcherPagedQueryOptions<R, FIELDS, E, Q>,
): UseFetcherPagedQueryReturn<R, FIELDS, E, Q>;

typescript/wow-react/src/fetcher/useFetcherPagedQuery.ts:113

UseFetcherPagedQueryOptions ​

ts
export interface UseFetcherPagedQueryOptions<
  R,
  FIELDS extends string = string,
  E = FetcherError,
  Q extends PagedQueryRequest<FIELDS> = FilterPagedQuery<FIELDS>,
> extends UseFetcherQueryOptions<Q, PagedList<R>, E> {}

typescript/wow-react/src/fetcher/useFetcherPagedQuery.ts:35

UseFetcherPagedQueryReturn ​

ts
export interface UseFetcherPagedQueryReturn<
  R,
  FIELDS extends string = string,
  E = FetcherError,
  Q extends PagedQueryRequest<FIELDS> = FilterPagedQuery<FIELDS>,
> extends UseQueryReturn<Q, PagedList<R>, E> {}

typescript/wow-react/src/fetcher/useFetcherPagedQuery.ts:52

useFetcherSingleQuery ​

ts
export function useFetcherSingleQuery<
  R,
  FIELDS extends string = string,
  E = FetcherError,
>(
  options: UseFetcherSingleQueryOptions<
    R,
    FIELDS,
    E,
    FilterSingleQuery<FIELDS>
  >,
): UseFetcherSingleQueryReturn<R, FIELDS, E, FilterSingleQuery<FIELDS>>;

typescript/wow-react/src/fetcher/useFetcherSingleQuery.ts:94

ts
export function useFetcherSingleQuery<
  R,
  FIELDS extends string = string,
  E = FetcherError,
>(
  options: UseFetcherSingleQueryOptions<R, FIELDS, E, SingleQuery<FIELDS>>,
): UseFetcherSingleQueryReturn<R, FIELDS, E, SingleQuery<FIELDS>>;

typescript/wow-react/src/fetcher/useFetcherSingleQuery.ts:106

ts
export function useFetcherSingleQuery<
  R,
  FIELDS extends string = string,
  E = FetcherError,
  Q extends SingleQueryRequest<FIELDS> = FilterSingleQuery<FIELDS>,
>(
  options: UseFetcherSingleQueryOptions<R, FIELDS, E, Q>,
): UseFetcherSingleQueryReturn<R, FIELDS, E, Q>;

typescript/wow-react/src/fetcher/useFetcherSingleQuery.ts:113

UseFetcherSingleQueryOptions ​

ts
export interface UseFetcherSingleQueryOptions<
  R,
  FIELDS extends string = string,
  E = FetcherError,
  Q extends SingleQueryRequest<FIELDS> = FilterSingleQuery<FIELDS>,
> extends UseFetcherQueryOptions<Q, R, E> {}

typescript/wow-react/src/fetcher/useFetcherSingleQuery.ts:34

UseFetcherSingleQueryReturn ​

ts
export interface UseFetcherSingleQueryReturn<
  R,
  FIELDS extends string = string,
  E = FetcherError,
  Q extends SingleQueryRequest<FIELDS> = FilterSingleQuery<FIELDS>,
> extends UseQueryReturn<Q, R, E> {}

typescript/wow-react/src/fetcher/useFetcherSingleQuery.ts:50

useCountQuery ​

ts
export function useCountQuery<FIELDS extends string = string, E = FetcherError>(
  options: UseCountQueryOptions<FIELDS, E, FilterExpression<FIELDS>>,
): UseCountQueryReturn<FIELDS, E, FilterExpression<FIELDS>>;

typescript/wow-react/src/useCountQuery.ts:84

ts
export function useCountQuery<FIELDS extends string = string, E = FetcherError>(
  options: UseCountQueryOptions<FIELDS, E, Condition<FIELDS>>,
): UseCountQueryReturn<FIELDS, E, Condition<FIELDS>>;

typescript/wow-react/src/useCountQuery.ts:87

ts
export function useCountQuery<
  FIELDS extends string = string,
  E = FetcherError,
  Q extends Condition<FIELDS> | FilterExpression<FIELDS> =
    FilterExpression<FIELDS>,
>(
  options: UseCountQueryOptions<FIELDS, E, Q>,
): UseCountQueryReturn<FIELDS, E, Q>;

typescript/wow-react/src/useCountQuery.ts:90

UseCountQueryOptions ​

ts
export interface UseCountQueryOptions<
  FIELDS extends string = string,
  E = FetcherError,
  Q extends Condition<FIELDS> | FilterExpression<FIELDS> =
    FilterExpression<FIELDS>,
> extends UseQueryOptions<Q, number, E> {}

typescript/wow-react/src/useCountQuery.ts:30

UseCountQueryReturn ​

ts
export interface UseCountQueryReturn<
  FIELDS extends string = string,
  E = FetcherError,
  Q extends Condition<FIELDS> | FilterExpression<FIELDS> =
    FilterExpression<FIELDS>,
> extends UseQueryReturn<Q, number, E> {}

typescript/wow-react/src/useCountQuery.ts:44

useListQuery ​

ts
export function useListQuery<
  R,
  FIELDS extends string = string,
  E = FetcherError,
>(
  options: UseListQueryOptions<R, FIELDS, E, FilterListQuery<FIELDS>>,
): UseListQueryReturn<R, FIELDS, E, FilterListQuery<FIELDS>>;

typescript/wow-react/src/useListQuery.ts:93

ts
export function useListQuery<
  R,
  FIELDS extends string = string,
  E = FetcherError,
>(
  options: UseListQueryOptions<R, FIELDS, E, ListQuery<FIELDS>>,
): UseListQueryReturn<R, FIELDS, E, ListQuery<FIELDS>>;

typescript/wow-react/src/useListQuery.ts:100

ts
export function useListQuery<
  R,
  FIELDS extends string = string,
  E = FetcherError,
  Q extends ListQueryRequest<FIELDS> = FilterListQuery<FIELDS>,
>(
  options: UseListQueryOptions<R, FIELDS, E, Q>,
): UseListQueryReturn<R, FIELDS, E, Q>;

typescript/wow-react/src/useListQuery.ts:107

UseListQueryOptions ​

ts
export interface UseListQueryOptions<
  R,
  FIELDS extends string = string,
  E = FetcherError,
  Q extends ListQueryRequest<FIELDS> = FilterListQuery<FIELDS>,
> extends UseQueryOptions<Q, R[], E> {}

typescript/wow-react/src/useListQuery.ts:32

UseListQueryReturn ​

ts
export interface UseListQueryReturn<
  R,
  FIELDS extends string = string,
  E = FetcherError,
  Q extends ListQueryRequest<FIELDS> = FilterListQuery<FIELDS>,
> extends UseQueryReturn<Q, R[], E> {}

typescript/wow-react/src/useListQuery.ts:47

useListStreamQuery ​

ts
export function useListStreamQuery<
  R,
  FIELDS extends string = string,
  E = FetcherError | WowError,
>(
  options: UseListStreamQueryOptions<R, FIELDS, E, FilterListQuery<FIELDS>>,
): UseListStreamQueryReturn<R, FIELDS, E, FilterListQuery<FIELDS>>;

typescript/wow-react/src/useListStreamQuery.ts:127

ts
export function useListStreamQuery<
  R,
  FIELDS extends string = string,
  E = FetcherError | WowError,
>(
  options: UseListStreamQueryOptions<R, FIELDS, E, ListQuery<FIELDS>>,
): UseListStreamQueryReturn<R, FIELDS, E, ListQuery<FIELDS>>;

typescript/wow-react/src/useListStreamQuery.ts:134

ts
export function useListStreamQuery<
  R,
  FIELDS extends string = string,
  E = FetcherError | WowError,
  Q extends ListQueryRequest<FIELDS> = FilterListQuery<FIELDS>,
>(
  options: UseListStreamQueryOptions<R, FIELDS, E, Q>,
): UseListStreamQueryReturn<R, FIELDS, E, Q>;

typescript/wow-react/src/useListStreamQuery.ts:141

UseListStreamQueryOptions ​

ts
export interface UseListStreamQueryOptions<
  R,
  FIELDS extends string = string,
  E = FetcherError | WowError,
  Q extends ListQueryRequest<FIELDS> = FilterListQuery<FIELDS>,
> extends Omit<UseQueryOptions<Q, R[], E>, 'execute'> {
  /** Opens the stream for a query. */
  execute: ListStreamExecutor<R, Q>;
}

typescript/wow-react/src/useListStreamQuery.ts:51

UseListStreamQueryReturn ​

ts
export interface UseListStreamQueryReturn<
  R,
  FIELDS extends string = string,
  E = FetcherError | WowError,
  Q extends ListQueryRequest<FIELDS> = FilterListQuery<FIELDS>,
> extends Omit<UseQueryReturn<Q, R[], E>, 'result'> {
  /** The rows of the current query received so far. */
  items: R[];
  /** Whether the stream ended normally, so `items` holds every row. */
  done: boolean;
}

typescript/wow-react/src/useListStreamQuery.ts:76

ListStreamExecutor ​

ts
export type ListStreamExecutor<R, Q> = (
  query: Q,
  attributes?: Record<string, any>,
  abortController?: AbortController,
) => Promise<ReadableStream<JsonServerSentEvent<R>>>;

typescript/wow-react/src/useListStreamQuery.ts:33

usePagedQuery ​

ts
export function usePagedQuery<
  R,
  FIELDS extends string = string,
  E = FetcherError,
>(
  options: UsePagedQueryOptions<R, FIELDS, E, FilterPagedQuery<FIELDS>>,
): UsePagedQueryReturn<R, FIELDS, E, FilterPagedQuery<FIELDS>>;

typescript/wow-react/src/usePagedQuery.ts:95

ts
export function usePagedQuery<
  R,
  FIELDS extends string = string,
  E = FetcherError,
>(
  options: UsePagedQueryOptions<R, FIELDS, E, PagedQuery<FIELDS>>,
): UsePagedQueryReturn<R, FIELDS, E, PagedQuery<FIELDS>>;

typescript/wow-react/src/usePagedQuery.ts:102

ts
export function usePagedQuery<
  R,
  FIELDS extends string = string,
  E = FetcherError,
  Q extends PagedQueryRequest<FIELDS> = FilterPagedQuery<FIELDS>,
>(
  options: UsePagedQueryOptions<R, FIELDS, E, Q>,
): UsePagedQueryReturn<R, FIELDS, E, Q>;

typescript/wow-react/src/usePagedQuery.ts:109

UsePagedQueryOptions ​

ts
export interface UsePagedQueryOptions<
  R,
  FIELDS extends string = string,
  E = FetcherError,
  Q extends PagedQueryRequest<FIELDS> = FilterPagedQuery<FIELDS>,
> extends UseQueryOptions<Q, PagedList<R>, E> {}

typescript/wow-react/src/usePagedQuery.ts:35

UsePagedQueryReturn ​

ts
export interface UsePagedQueryReturn<
  R,
  FIELDS extends string = string,
  E = FetcherError,
  Q extends PagedQueryRequest<FIELDS> = FilterPagedQuery<FIELDS>,
> extends UseQueryReturn<Q, PagedList<R>, E> {}

typescript/wow-react/src/usePagedQuery.ts:50

useSingleQuery ​

ts
export function useSingleQuery<
  R,
  FIELDS extends string = string,
  E = FetcherError,
>(
  options: UseSingleQueryOptions<R, FIELDS, E, FilterSingleQuery<FIELDS>>,
): UseSingleQueryReturn<R, FIELDS, E, FilterSingleQuery<FIELDS>>;

typescript/wow-react/src/useSingleQuery.ts:92

ts
export function useSingleQuery<
  R,
  FIELDS extends string = string,
  E = FetcherError,
>(
  options: UseSingleQueryOptions<R, FIELDS, E, SingleQuery<FIELDS>>,
): UseSingleQueryReturn<R, FIELDS, E, SingleQuery<FIELDS>>;

typescript/wow-react/src/useSingleQuery.ts:99

ts
export function useSingleQuery<
  R,
  FIELDS extends string = string,
  E = FetcherError,
  Q extends SingleQueryRequest<FIELDS> = FilterSingleQuery<FIELDS>,
>(
  options: UseSingleQueryOptions<R, FIELDS, E, Q>,
): UseSingleQueryReturn<R, FIELDS, E, Q>;

typescript/wow-react/src/useSingleQuery.ts:106

UseSingleQueryOptions ​

ts
export interface UseSingleQueryOptions<
  R,
  FIELDS extends string = string,
  E = FetcherError,
  Q extends SingleQueryRequest<FIELDS> = FilterSingleQuery<FIELDS>,
> extends UseQueryOptions<Q, R, E> {}

typescript/wow-react/src/useSingleQuery.ts:35

UseSingleQueryReturn ​

ts
export interface UseSingleQueryReturn<
  R,
  FIELDS extends string = string,
  E = FetcherError,
  Q extends SingleQueryRequest<FIELDS> = FilterSingleQuery<FIELDS>,
> extends UseQueryReturn<Q, R, E> {}

typescript/wow-react/src/useSingleQuery.ts:50

相关专题 ​

Fetcher 请求 Hook · Promise 与查询状态 · 快照查询 · 过滤表达式 · 投影、排序与分页 · Storybook：Wow 查询 Hook

Released under the Apache 2.0 License.

Copyright © 2022-present Ahoo Wang