diff --git a/.changeset/lucky-onions-wait.md b/.changeset/lucky-onions-wait.md new file mode 100644 index 00000000..a0a795ef --- /dev/null +++ b/.changeset/lucky-onions-wait.md @@ -0,0 +1,5 @@ +--- +'@capawesome/capacitor-file-picker': major +--- + +refactor: remove `File` interface diff --git a/packages/file-picker/BREAKING.md b/packages/file-picker/BREAKING.md index 55cad1df..e1a61427 100644 --- a/packages/file-picker/BREAKING.md +++ b/packages/file-picker/BREAKING.md @@ -13,6 +13,10 @@ This is a comprehensive list of the breaking changes introduced in the major ver The `multiple` property has been replaced by a new `limit` property in the `PickFilesOptions` and `PickMediaOptions` interfaces. +### `File` interface + +The `File` interface has been replaced by the `PickedFile` interface. + ## Version 5.x.x ### Capacitor 5 diff --git a/packages/file-picker/src/definitions.ts b/packages/file-picker/src/definitions.ts index 08d2de35..db8e1578 100644 --- a/packages/file-picker/src/definitions.ts +++ b/packages/file-picker/src/definitions.ts @@ -123,15 +123,7 @@ export interface PickFilesResult { files: PickedFile[]; } -/** - * @since 0.5.3 - */ -export type PickedFile = File; - -/** - * @deprecated Use `PickedFile` instead. - */ -export interface File { +export interface PickedFile { /** * The Blob instance of the file. * diff --git a/packages/file-picker/src/web.ts b/packages/file-picker/src/web.ts index 1afcd51f..826ee5db 100644 --- a/packages/file-picker/src/web.ts +++ b/packages/file-picker/src/web.ts @@ -3,7 +3,6 @@ import { WebPlugin } from '@capacitor/core'; import type { ConvertHeicToJpegOptions, ConvertHeicToJpegResult, - File as FileModel, FilePickerPlugin, PickFilesOptions, PickFilesResult, @@ -13,6 +12,7 @@ import type { PickMediaResult, PickVideosOptions, PickVideosResult, + PickedFile, } from './definitions'; export class FilePickerWeb extends WebPlugin implements FilePickerPlugin { @@ -33,7 +33,7 @@ export class FilePickerWeb extends WebPlugin implements FilePickerPlugin { files: [], }; for (const pickedFile of pickedFiles) { - const file: FileModel = { + const file: PickedFile = { blob: pickedFile, modifiedAt: pickedFile.lastModified, mimeType: this.getMimeTypeFromUrl(pickedFile),