@ahoo-wang/wow-react symbol index
Every name @ahoo-wang/wow-react exports — 35 — with its kind and the first sentence of its TSDoc, generated from the built declarations. 0 of them are described by hand in the curated pages, linked in the last column; the rest are read from their source through the signature in the API report. This index is English only.
| Symbol | Kind | Summary | Covered in |
|---|---|---|---|
ListStreamExecutor | type | Opens the event stream of one query: a query client's listStream, or any function that resolves to a stream of rows. | — |
QueryExecutor | type | Runs one query: a query client's method, such as a generated…SnapshotQueryClient's paged, or any function that resolves to the result. | — |
QueryHookOptions | interface | The options every query hook takes. | — |
QueryHookReturn | interface | What every query hook returns. | — |
QueryStatus | type | Where a query hook stands: | — |
UseCountQueryOptions | interface | Options of useCountQuery: a filter and an execute that resolves to how many rows it matches. | — |
UseCountQueryReturn | interface | What useCountQuery returns: the count as result. | — |
UseFetcherCountQueryOptions | interface | Options of useFetcherCountQuery: those of every query hook, with the endpoint and the Fetcher in place of execute. | — |
UseFetcherCountQueryReturn | interface | What useFetcherCountQuery returns: the count as result. | — |
UseFetcherListQueryOptions | interface | Options of useFetcherListQuery: those of every query hook, with the endpoint and the Fetcher in place of execute. | — |
UseFetcherListQueryReturn | interface | What useFetcherListQuery returns: the rows as result. | — |
UseFetcherListStreamQueryOptions | interface | Options of useFetcherListStreamQuery: those of useListStreamQuery, with the endpoint and the Fetcher in place of execute. | — |
UseFetcherListStreamQueryReturn | interface | What useFetcherListStreamQuery returns; seeUseListStreamQueryReturn. | — |
UseFetcherPagedQueryOptions | interface | Options of useFetcherPagedQuery: those of every query hook, with the endpoint and the Fetcher in place of execute. | — |
UseFetcherPagedQueryReturn | interface | What useFetcherPagedQuery returns: the page (total and list) as result. | — |
UseFetcherSingleQueryOptions | interface | Options of useFetcherSingleQuery: those of every query hook, with the endpoint and the Fetcher in place of execute. | — |
UseFetcherSingleQueryReturn | interface | What useFetcherSingleQuery returns: the item as result. | — |
UseListQueryOptions | interface | Options of useListQuery: a list query and an execute that resolves to its rows. | — |
UseListQueryReturn | interface | What useListQuery returns: the rows as result. | — |
UseListStreamQueryOptions | interface | Options of useListStreamQuery: those of every query hook, with anexecute that opens the stream. | — |
UseListStreamQueryReturn | interface | What useListStreamQuery and useFetcherListStreamQuery return: the rows as they arrive, and whether the stream has ended. | — |
UsePagedQueryOptions | interface | Options of usePagedQuery: a paged query and an execute that resolves to one page. | — |
UsePagedQueryReturn | interface | What usePagedQuery returns: the page (total and list) asresult. | — |
UseSingleQueryOptions | interface | Options of useSingleQuery: a single query and an execute that resolves to one item. | — |
UseSingleQueryReturn | interface | What useSingleQuery returns: the item as result. | — |
useCountQuery | function | Counts what a filter matches through your own execute function and keeps the count as state: typically a query client's count. | — |
useFetcherCountQuery | function | POSTs a count to a Wow query route through a Fetcher and keeps the count as state. | — |
useFetcherListQuery | function | POSTs a list query to a Wow query route through a Fetcher and keeps the rows as state. | — |
useFetcherListStreamQuery | function | Streams the rows of a list query from a Wow query route and keeps them as state; see useListStreamQuery for the state it returns. | — |
useFetcherPagedQuery | function | POSTs a paged query to a Wow query route through a Fetcher and keeps the page as state. | — |
useFetcherSingleQuery | function | POSTs a single query to a Wow query route through a Fetcher and keeps the result as state. | — |
useListQuery | function | Runs a list query through your own execute function and keeps the rows as state: typically a query client's list or listState. | — |
useListStreamQuery | function | Streams the rows of a list query as server-sent events and keeps them as state. | — |
usePagedQuery | function | Runs a paged query through your own execute function and keeps the page as state: typically a query client's paged or pagedState. | — |
useSingleQuery | function | Runs a single query through your own execute function and keeps the result as state: typically a query client's single or singleState. | — |