Vue OpenAPI Query Documentation
    Preparing search index...

    Interface CacheInvalidationOptions

    Options for controlling automatic cache invalidation after mutations.

    interface CacheInvalidationOptions {
        dontInvalidate?: boolean;
        dontUpdateCache?: boolean;
        invalidateOperations?:
            | Record<string, Record<string, string | undefined>>
            | string[];
        refetchEndpoints?: Refetchable[];
    }
    Index

    Properties

    dontInvalidate? dontUpdateCache? invalidateOperations? refetchEndpoints?

    Properties

    dontInvalidate?: boolean

    Skip automatic cache invalidation.

    false

    Note: when a PUT/PATCH response body has been written to the cache (see dontUpdateCache), the exact item query is not additionally invalidated — the cached value already is the server's latest state, and refetching it would race with subsequent mutations. List-path and invalidateOperations invalidation still run. Set dontUpdateCache: true to force invalidation-based refetching instead.

    dontUpdateCache?: boolean

    Skip automatic cache update for PUT/PATCH responses.

    false
    invalidateOperations?:
        | Record<string, Record<string, string | undefined>>
        | string[]

    Additional operation IDs to invalidate after mutation succeeds. Array of operation name strings, or map of operation name → path params.

    ['listPets']

    { getPet: { petId: '123' } }
    refetchEndpoints?: Refetchable[]

    Specific query endpoints to refetch after mutation succeeds.

    Settings

    Member Visibility

    On This Page

    Properties