UseSubmitCommandResult
Defined in: packages/react/src/hooks/useSubmitCommand.ts:35
Properties
Section titled “Properties”data: {
tx: {commandId:string;payload: {completionOffset:number;updateId:string; };status:"executed"; }; } |undefined
Defined in: packages/react/src/hooks/useSubmitCommand.ts:47
Result from the last successful submission
error:
ParsedError|null
Defined in: packages/react/src/hooks/useSubmitCommand.ts:45
Error from the last submission
isError
Section titled “isError”isError:
boolean
Defined in: packages/react/src/hooks/useSubmitCommand.ts:43
Whether the last submission failed
isPending
Section titled “isPending”isPending:
boolean
Defined in: packages/react/src/hooks/useSubmitCommand.ts:41
Whether a submission is in progress
reset()
Section titled “reset()”reset: () =>
void
Defined in: packages/react/src/hooks/useSubmitCommand.ts:49
Reset the mutation state
Returns
Section titled “Returns”void
submit()
Section titled “submit()”submit: (
params) =>void
Defined in: packages/react/src/hooks/useSubmitCommand.ts:37
Submit a command
Parameters
Section titled “Parameters”params
Section titled “params”actAs?
Section titled “actAs?”string[]
commandId?
Section titled “commandId?”string
commands
Section titled “commands”z.ZodRecord<z.ZodString, z.ZodAny>
disclosedContracts?
Section titled “disclosedContracts?”object[]
packageIdSelectionPreference?
Section titled “packageIdSelectionPreference?”string[]
readAs?
Section titled “readAs?”string[]
synchronizerId?
Section titled “synchronizerId?”string
Returns
Section titled “Returns”void
submitAsync()
Section titled “submitAsync()”submitAsync: (
params) =>Promise<{tx: {commandId:string;payload: {completionOffset:number;updateId:string; };status:"executed"; }; }>
Defined in: packages/react/src/hooks/useSubmitCommand.ts:39
Submit async with promise return
Parameters
Section titled “Parameters”params
Section titled “params”actAs?
Section titled “actAs?”string[]
commandId?
Section titled “commandId?”string
commands
Section titled “commands”z.ZodRecord<z.ZodString, z.ZodAny>
disclosedContracts?
Section titled “disclosedContracts?”object[]
packageIdSelectionPreference?
Section titled “packageIdSelectionPreference?”string[]
readAs?
Section titled “readAs?”string[]
synchronizerId?
Section titled “synchronizerId?”string
Returns
Section titled “Returns”Promise<{ tx: { commandId: string; payload: { completionOffset: number; updateId: string; }; status: "executed"; }; }>