Skip to content

README.md

Latest commit

 

History

History
53 lines (38 loc) · 1.45 KB

README.md

File metadata and controls

53 lines (38 loc) · 1.45 KB

@spoosh/plugin-refetch

Auto-refetch plugin for Spoosh - refetch on window focus and network reconnect.

Documentation · Requirements: TypeScript >= 5.0 · Peer Dependencies: @spoosh/core

Installation

npm install @spoosh/plugin-refetch

Usage

import { Spoosh } from "@spoosh/core";
import { refetchPlugin } from "@spoosh/plugin-refetch";

const spoosh = new Spoosh<ApiSchema, Error>("/api").use([
  refetchPlugin({
    refetchOnFocus: true,
    refetchOnReconnect: true,
  }),
]);

// Uses plugin defaults
useRead((api) => api("posts").GET());

// Per-query override
useRead((api) => api("posts").GET(), {
  refetch: {
    onFocus: false, // Disable for this query
  },
});

Options

Plugin Config

Option Type Default Description
refetchOnFocus boolean false Refetch when window regains focus
refetchOnReconnect boolean false Refetch when network reconnects

Per-Request Options

Pass options via the refetch object:

Option Type Description
onFocus boolean Override focus refetch behavior
onReconnect boolean Override reconnect refetch behavior