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

danielroe · danielroe · commit 0d9c63b828f4 · 2024-03-17T20:09:19.000+01:00
resolves #26317
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
 }
 

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ export type LoadingIndicator = {`
`25`	`25`	`isLoading: Ref<boolean>`
`26`	`26`	`start: () => void`
`27`	`27`	`set: (value: number) => void`
`28`		`- finish: (opts: { force?: boolean }) => void`
	`28`	`+ finish: (opts?: { force?: boolean }) => void`
`29`	`29`	`clear: () => void`
`30`	`30`	`}`
`31`	`31`