Interface IWithQuery<TRequestSchema, TResponseSchema>

This is a base object containing everything you need to use a query.

interface IWithQuery<TRequestSchema, TResponseSchema> {
    key: QueryKey;
    schema: {
        request: TRequestSchema;
        response: TResponseSchema;
    };
    useCallback(): ((request) => Promise<TypeOf<TResponseSchema>>);
}

Type Parameters

TRequestSchema extends RequestSchema
Shape of the request schema.
TResponseSchema extends ResponseSchema
Shape of the response schema.

Hierarchy

IInvalidator
- IWithQuery

Index

Methods

Properties

Methods

useCallback

useCallback(): ((request) => Promise<TypeOf<TResponseSchema>>)
This is the actual query function.

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

Properties

key

key: QueryKey

Query key used in React Query

schema

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

This is obvious, isn't it?

Type declaration

request: TRequestSchema
response: TResponseSchema