Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(useFileDialog): type UseFileDialogReturn #1927

Merged
merged 1 commit into from Jul 16, 2022
Merged

Conversation

xiaoxiangmoe
Copy link
Contributor

Description

/// <reference types="node" />
export interface UseFileDialogOptions extends ConfigurableDocument {
  /**
   * @default true
   */
  multiple?: boolean
  /**
   * @default '*'
   */
  accept?: string
  /**
   * Select the input source for the capture file.
   * @see [HTMLInputElement Capture](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/capture)
   */
  capture?: string
}
/**
 * Open file dialog with ease.
 *
 * @see https://vueuse.org/useFileDialog
 * @param options
 */
export declare function useFileDialog(options?: UseFileDialogOptions): {
  files: Readonly<
    Ref<{
      readonly [x: number]: {
        readonly lastModified: number
        readonly name: string
        readonly webkitRelativePath: string
        readonly path: string
        readonly size: number
        readonly type: string
        readonly arrayBuffer: {
          (): Promise<ArrayBuffer>
          (): Promise<ArrayBuffer>
        }
        readonly slice: {
          (
            start?: number | undefined,
            end?: number | undefined,
            contentType?: string | undefined
          ): Blob
          (
            start?: number | undefined,
            end?: number | undefined,
            contentType?: string | undefined
          ): Blob
        }
        readonly stream: {
          (): ReadableStream<Uint8Array>
          (): NodeJS.ReadableStream
        }
        readonly text: {
          (): Promise<string>
          (): Promise<string>
        }
      }
      readonly length: number
      readonly item: (index: number) => File | null
      readonly [Symbol.iterator]: () => IterableIterator<File>
    } | null>
  >
  open: (localOptions?: Partial<UseFileDialogOptions>) => void
  reset: () => void
}

This type has type error in browser because NodeJS.ReadableStream is needed.

        readonly stream: {
          (): ReadableStream<Uint8Array>
          (): NodeJS.ReadableStream
        }

Additional context


What is the purpose of this pull request?

  • Bug fix
  • New Feature
  • Documentation update
  • Other

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines.
  • Read the Pull Request Guidelines.
  • Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
  • Ideally, include relevant tests that fail without this PR but pass with it.

@antfu antfu changed the title fix: type UseFileDialogReturn fix(useFileDialog): type UseFileDialogReturn Jul 16, 2022
@antfu antfu merged commit 4619206 into vueuse:main Jul 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants