Interface Props<TRequestSchema, TResponseSchema>

Props for withMutation method.

interface Props<TRequestSchema, TResponseSchema> {
    key: MutationKey;
    schema: {
        request: TRequestSchema;
        response: TResponseSchema;
    };
    useCallback(): ((request) => Promise<TypeOf<TResponseSchema>>);
    invalidator?: ((props) => Promise<unknown>);
    defaultOptions?: Options<TRequestSchema, TResponseSchema>;
}

Type Parameters

TRequestSchema extends RequestSchema
Request schema.
TResponseSchema extends ResponseSchema
Response schema.

Index

Methods

Properties

key schema invalidator? defaultOptions?

Methods

useCallback

useCallback(): ((request) => Promise<TypeOf<TResponseSchema>>)
Callback used to execute the mutation.

Returns ((request) => Promise<TypeOf<TResponseSchema>>)
- - (request): Promise<TypeOf<TResponseSchema>>
  - Parameters
    - request: TypeOf<TRequestSchema>
    Returns Promise<TypeOf<TResponseSchema>>
- Defined in packages/client/src/query/withMutation.ts:51

Properties

key

key: MutationKey

Query key used to cache the result.

schema

schema: {
request: TRequestSchema;
response: TResponseSchema;
}

Mutation schemas.

Type declaration

request: TRequestSchema
Request schema.
response: TResponseSchema
Response schema.

`Optional` invalidator

invalidator?: ((props) => Promise<unknown>)

Callback used to invalidate the query cache.

Type declaration

- (props): Promise<unknown>
- Parameters
  - props: Props
  Returns Promise<unknown>

`Optional` defaultOptions

defaultOptions?: Options<TRequestSchema, TResponseSchema>

Default options for the mutation.