fix(nuxt): correct finish types and add to docs

resolves #26317
nuxt · Mar 17, 2024 · 0d9c63b · 0d9c63b
1 parent 401370b
commit 0d9c63b
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/docs/3.api/2.composables/use-loading-indicator.md b/docs/3.api/2.composables/use-loading-indicator.md
@@ -39,7 +39,7 @@ Set `isLoading` to true and start to increase the `progress` value.
 
 ### `finish()`
 
-Set the `progress` value to `100`, stop all timers and intervals then reset the loading state `500` ms later.
+Set the `progress` value to `100`, stop all timers and intervals then reset the loading state `500` ms later. `finish` accepts a `{ force: true }` option to skip the interval before the state is reset.
 
 ### `clear()`
 

diff --git a/packages/nuxt/src/app/composables/loading-indicator.ts b/packages/nuxt/src/app/composables/loading-indicator.ts
@@ -25,7 +25,7 @@ export type LoadingIndicator = {
   isLoading: Ref<boolean>
   start: () => void
   set: (value: number) => void
-  finish: (opts: { force?: boolean }) => void
+  finish: (opts?: { force?: boolean }) => void
   clear: () => void
 }