fix(useFileDialog): explict UseFileDialogReturn type (#1927)

vueuse · Jul 16, 2022 · 4619206 · 4619206
1 parent e84fa0f
commit 4619206
Showing 1 changed file with 8 additions and 4 deletions.
diff --git a/packages/core/useFileDialog/index.ts b/packages/core/useFileDialog/index.ts
@@ -1,4 +1,4 @@
-import { readonly, ref } from 'vue-demi'
+import { type Ref, readonly, ref } from 'vue-demi'
 import type { ConfigurableDocument } from '../_configurable'
 import { defaultDocument } from '../_configurable'
 
@@ -23,13 +23,19 @@ const DEFAULT_OPTIONS: UseFileDialogOptions = {
   accept: '*',
 }
 
+export interface UseFileDialogReturn {
+  files: Ref<FileList | null>
+  open: (localOptions?: Partial<UseFileDialogOptions>) => void
+  reset: () => void
+}
+
 /**
  * Open file dialog with ease.
  *
  * @see https://vueuse.org/useFileDialog
  * @param options
  */
-export function useFileDialog(options: UseFileDialogOptions = {}) {
+export function useFileDialog(options: UseFileDialogOptions = {}): UseFileDialogReturn {
   const {
     document = defaultDocument,
   } = options
@@ -74,5 +80,3 @@ export function useFileDialog(options: UseFileDialogOptions = {}) {
     reset,
   }
 }
-
-export type UseFileDialogReturn = ReturnType<typeof useFileDialog>