UseLedgerApiResult
Defined in: packages/react/src/hooks/useLedgerApi.ts:29
Type Parameters
Section titled “Type Parameters”T = unknown
Properties
Section titled “Properties”data:
LedgerApiResponse<T> |undefined
Defined in: packages/react/src/hooks/useLedgerApi.ts:41
Response data from the last successful request
error:
Error|null
Defined in: packages/react/src/hooks/useLedgerApi.ts:39
Error from the last request
isError
Section titled “isError”isError:
boolean
Defined in: packages/react/src/hooks/useLedgerApi.ts:37
Whether the last request failed
isPending
Section titled “isPending”isPending:
boolean
Defined in: packages/react/src/hooks/useLedgerApi.ts:35
Whether a request is in progress
request()
Section titled “request()”request: (
params) =>void
Defined in: packages/react/src/hooks/useLedgerApi.ts:31
Execute a ledger API request
Parameters
Section titled “Parameters”params
Section titled “params”Record<string, any>
headers?
Section titled “headers?”Record<string, any>
Record<string, any>
query?
Section titled “query?”Record<string, any>
requestMethod
Section titled “requestMethod”"get" | "post" | "patch" | "put" | "delete"
resource
Section titled “resource”string
Returns
Section titled “Returns”void
requestAsync()
Section titled “requestAsync()”requestAsync: (
params) =>Promise<LedgerApiResponse<T>>
Defined in: packages/react/src/hooks/useLedgerApi.ts:33
Execute async with promise return
Parameters
Section titled “Parameters”params
Section titled “params”Record<string, any>
headers?
Section titled “headers?”Record<string, any>
Record<string, any>
query?
Section titled “query?”Record<string, any>
requestMethod
Section titled “requestMethod”"get" | "post" | "patch" | "put" | "delete"
resource
Section titled “resource”string
Returns
Section titled “Returns”Promise<LedgerApiResponse<T>>
reset()
Section titled “reset()”reset: () =>
void
Defined in: packages/react/src/hooks/useLedgerApi.ts:43
Reset the mutation state
Returns
Section titled “Returns”void