UseEndpointMutationOptions
Defined in: wp-typia-rest/src/react-client-types.ts:140
Options for useEndpointMutation().
Type Parameters
Section titled “Type Parameters”Req
Res
Context
Section titled “Context”Context = unknown
Properties
Section titled “Properties”client?
Section titled “client?”
optionalclient?:EndpointDataClient
Defined in: wp-typia-rest/src/react-client-types.ts:141
fetchFn?
Section titled “fetchFn?”
optionalfetchFn?:ApiFetch
Defined in: wp-typia-rest/src/react-client-types.ts:142
invalidate?
Section titled “invalidate?”
optionalinvalidate?:EndpointInvalidateTargets| ((data,variables,validation) =>EndpointInvalidateTargets)
Defined in: wp-typia-rest/src/react-client-types.ts:143
onError?
Section titled “onError?”
optionalonError?: (error,variables,client,context) =>void|Promise<void>
Defined in: wp-typia-rest/src/react-client-types.ts:150
Parameters
Section titled “Parameters”unknown
variables
Section titled “variables”Req
client
Section titled “client”context
Section titled “context”Context | undefined
Returns
Section titled “Returns”void | Promise<void>
onMutate?
Section titled “onMutate?”
optionalonMutate?: (variables,client) =>Context|Promise<Context>
Defined in: wp-typia-rest/src/react-client-types.ts:156
Parameters
Section titled “Parameters”variables
Section titled “variables”Req
client
Section titled “client”Returns
Section titled “Returns”Context | Promise<Context>
onSettled?
Section titled “onSettled?”
optionalonSettled?: (result,variables,client,context) =>void|Promise<void>
Defined in: wp-typia-rest/src/react-client-types.ts:160
Parameters
Section titled “Parameters”result
Section titled “result”Res | undefined
unknown
validation
Section titled “validation”EndpointValidationResult<Req, Res> | null
variables
Section titled “variables”Req
client
Section titled “client”context
Section titled “context”Context | undefined
Returns
Section titled “Returns”void | Promise<void>
onSuccess?
Section titled “onSuccess?”
optionalonSuccess?: (data,variables,validation,client,context) =>void|Promise<void>
Defined in: wp-typia-rest/src/react-client-types.ts:170
Parameters
Section titled “Parameters”Res | undefined
variables
Section titled “variables”Req
validation
Section titled “validation”EndpointResponseValidationResult<Res>
client
Section titled “client”context
Section titled “context”Context | undefined
Returns
Section titled “Returns”void | Promise<void>
resolveCallOptions?
Section titled “resolveCallOptions?”
optionalresolveCallOptions?: (variables) =>EndpointCallOptions|undefined
Defined in: wp-typia-rest/src/react-client-types.ts:177
Parameters
Section titled “Parameters”variables
Section titled “variables”Req
Returns
Section titled “Returns”EndpointCallOptions | undefined