chore(core): stop returning cancelledError on reset during fetch, fix docs

Author: amen-souissi

docs/src/pages/guides/dependent-queries.md

@@ -3,7 +3,7 @@ id: dependent-queries
 title: Dependent Queries
 ---
 
-Dependent (or serial) queries depend on previous ones to finish before they can execute. To achive this, it's as easy as using the `enabled` option to tell a query when it is ready to run:
+Dependent (or serial) queries depend on previous ones to finish before they can execute. To achieve this, it's as easy as using the `enabled` option to tell a query when it is ready to run:
 
 ```markdown
 <script>

docs/src/pages/plugins/persist-localstorage.md

@@ -11,16 +11,30 @@ This plugin comes packaged with `svelte-query` and is available under the `@svel
 
 ## Usage
 
-Import the `persistWithLocalStorage` function, and pass it your `QueryClient` instance!
+Import the `persistWithLocalStorage` function, and pass it your `QueryClient` instance (with a `cacheTime` set)!
 
 ```js
 import { persistWithLocalStorage } from '@sveltestack/svelte-query'
 
-const queryClient = new QueryClient()
+const queryClient = new QueryClient({
+  defaultOptions: {
+    queries: {
+      cacheTime: 1000 * 60 * 60 * 24 // 24 hours
+    }
+  }
+})
 
 persistWithLocalStorage(queryClient)
 ```
 
+**IMPORTANT** - for persist to work properly, you need to pass `QueryClient` a `cacheTime` value to override the default during hydration (as shown above).
+
+If it is not set when creating the `QueryClient` instance, it will default to `300000` (5 minutes) for hydration, and local storage will be discarded after 5 minutes of inactivity. This is the default garbage collection behavior.
+
+It should be set as the same value or higher than persistWithLocalStorage's `maxAge` option. E.g. if `maxAge` is 24 hours (the default) then `cacheTime` should be 24 hours or higher. If lower than `maxAge`, garbage collection will kick in and discard the local storage earlier than expected.
+
+You can also pass it `Infinity` to disable garbage collection behavior entirely.
+
 ## How does it work?
 
 As you use your application:

docs/src/pages/reference/useMutation.md

@@ -79,6 +79,7 @@ mutate(variables, {
     - Optional
     - The variables object to pass to the `mutationFn`.
   - Remaining options extend the same options described above in the `useMutation` hook.
+  - If you make multiple requests, `onSuccess` will fire only after the latest call you've made.
 - `mutateAsync: (variables: TVariables, { onSuccess, onSettled, onError }) => Promise<TData>`
   - Similar to `mutate` but returns a promise which can be awaited.
 - `status: string`

docs/src/pages/reference/useQuery.md

@@ -61,7 +61,7 @@ const result = useQuery({
 - `queryKey: string | unknown[]`
   - **Required**
   - The query key to use for this query.
-  - The query key will be hashed into a stable hash. See [Query Keys](./guides/query-keys) for more information.
+  - The query key will be hashed into a stable hash. See [Query Keys](../guides/query-keys) for more information.
   - The query will automatically update when this key changes (as long as `enabled` is not set to `false`).
 - `queryFn: (context: QueryFunctionContext) => Promise<TData>`
   - **Required, but only if no default query function has been defined**
@@ -71,7 +71,7 @@ const result = useQuery({
   - Must return a promise that will either resolves data or throws an error.
 - `enabled: boolean`
   - Set this to `false` to disable this query from automatically running.
-  - Can be used for [Dependent Queries](./guides/queries#dependent-queries).
+  - Can be used for [Dependent Queries](./guides/dependent-queries).
 - `retry: boolean | number | (failureCount: number, error: TError) => boolean`
   - If `false`, failed queries will not retry by default.
   - If `true`, failed queries will retry infinitely.

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sveltestack/svelte-query",
   "private": false,
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Hooks for managing, caching and syncing asynchronous and remote data in Svelte",
   "license": "MIT",
   "svelte": "svelte/index.js",

src/queryCore/core/onlineManager.ts

@@ -53,10 +53,12 @@ class OnlineManager extends Subscribable {
       this.setEventListener(onOnline => {
         // Listen to online
         window.addEventListener('online', onOnline, false)
+        window.addEventListener('offline', onOnline, false)
 
         return () => {
           // Be sure to unsubscribe if a new handler is set
           window.removeEventListener('online', onOnline)
+          window.removeEventListener('offline', onOnline)
         }
       })
     }

src/queryCore/core/query.ts

@@ -228,7 +228,7 @@ export class Query<
 
   destroy(): void {
     this.clearGcTimeout()
-    this.cancel()
+    this.cancel({ silent: true })
   }
 
   reset(): void {