API reference · generated from source
Type Alias: ConvexQueryNodeResult<Query>#
type ConvexQueryNodeResult<Query> =
| {
status: "pending";
}
| {
status: "skipped";
}
| {
data: FunctionReturnType<Query>;
isStale?: boolean;
status: "success";
}
| {
error: Error;
status: "error";
};Defined in: retree-convex/src/types.ts:369
Result metadata for a ConvexQueryNode.
Type Parameters#
| Type Parameter |
|---|
Query extends QueryReference |
Union Members#
Type Literal#
{
status: "pending";
}Type Literal#
{
status: "skipped";
}Type Literal#
{
data: FunctionReturnType<Query>;
isStale?: boolean;
status: "success";
}data#
data: FunctionReturnType<Query>;isStale?#
optional isStale?: boolean;True while updateArgs keeps the previous data visible
(keepPreviousData) and the new subscription has not emitted yet.
status#
status: "success";Type Literal#
{
error: Error;
status: "error";
}