Interface ApiMutationOptions<TResponse>

interface ApiMutationOptions<TResponse> {
    errorMessage?: ErrorMessageI18nHandler;
    onSuccess?: ((response) => void);
    showToast: ((message) => void);
    successMessage?: string;
}

Type Parameters

TResponse

Index

Properties

errorMessage? onSuccess? showToast successMessage?

Properties

`Optional` errorMessage

errorMessage?: ErrorMessageI18nHandler

A function that returns the error message to show when the api call fails

`Optional` onSuccess

onSuccess?: ((response) => void)

Callback to run on success

Type declaration

- (response): void
- Callback to run on success
  Parameters
  - response: TResponse
  Returns void

showToast

showToast: ((message) => void)

A function that shows a toast message (required)

Type declaration

- (message): void
- A function that shows a toast message (required)
  Parameters
  - message: string
  Returns void

`Optional` successMessage

successMessage?: string

A message to show when the api call is successful

Generated using TypeDoc