Vue OpenAPI Query Documentation
    Preparing search index...

    Interface QueryClientLike

    Interface defining the minimal QueryClient methods required by this library.

    This interface ensures compatibility with different versions of @tanstack/vue-query by only requiring the specific methods that are actually used internally. This prevents version compatibility issues where internal implementation details (like private properties) might differ between versions.

    interface QueryClientLike {
        cancelQueries(
            filters: { queryKey: unknown[]; exact?: boolean },
        ): Promise<void>;
        setQueryData(queryKey: unknown[], data: unknown): void;
        invalidateQueries(
            filters: { queryKey: unknown[]; exact?: boolean },
        ): Promise<void>;
    }
    Index

    Methods

    cancelQueries setQueryData invalidateQueries

    Methods

    • Cancel running queries that match the provided filters. Used to prevent race conditions when mutations affect data.

      Parameters

      • filters: { queryKey: unknown[]; exact?: boolean }

      Returns Promise<void>

    • Set query data for a specific query key. Used for optimistic updates after successful mutations.

      Parameters

      • queryKey: unknown[]
      • data: unknown

      Returns void

    • Invalidate queries that match the provided filters. Used to trigger refetches of related data after mutations.

      Parameters

      • filters: { queryKey: unknown[]; exact?: boolean }

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Methods