Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

6.3 KB
Raw Blame

Expand

Type Parameters

Type Parameter
TParameters extends Record<string, unknown>
TKind extends ActionKind | undefined

Properties

Property Type Description
error ActionExecuteError | null Last thrown error, normalized to the public ActionExecuteError shape, or null.
execute (parameters: TParameters) => Promise<ActionResultForKind<TKind> | null> Trigger the action with the given parameters. Returns the response body on success AND throws on failure — the same error is stored in error for render-time consumers. Resolves to the discriminated result shape (see ActionResultForKind<TKind>); when TKind is omitted it resolves to AnyActionResult, narrowable via "<key>" in r. Resolves to null (without making a request) when actionId is null or the SDK is not yet initialized — guard the host-side caller with if (!actionId) return; if these cases are reachable.
isExecuting boolean -
reset () => void Clear result and error.
result ActionResultForKind<TKind> | null Last response, or null before first call and after reset().