expo-document-picker/src/types.ts

Provides access to the system's UI for selecting documents from the available providers on the user's device.

// @needsAudit
export type DocumentPickerOptions = {
  /**
   * The [MIME type(s)](https://en.wikipedia.org/wiki/Media_type) of the documents that are available
   * to be picked. It also supports wildcards like `'image/*'` to choose any image. To allow any type
   * of document you can use `'*/*'`.
   * @default '*/*'
   */
  type?: string | string[];
  /**
   * If `true`, the picked file is copied to [`FileSystem.CacheDirectory`](./filesystem#filesystemcachedirectory),
   * which allows other Expo APIs to read the file immediately. This may impact performance for
   * large files, so you should consider setting this to `false` if you expect users to pick
   * particularly large files and your app does not need immediate read access.
   * @platform ios
   * @platform android
   * @default true
   */
  copyToCacheDirectory?: boolean;
  /**
   * Allows multiple files to be selected from the system UI.
   * @default false
   *
   */
  multiple?: boolean;
  /**
   * If `true`, asset url is base64 from the file
   * If `false`, asset url is the file url parameter
   * @platform web
   * @default true
   */
  base64?: boolean;
};

export type DocumentPickerAsset = {
  /**
   * Document original name.
   */
  name: string;
  /**
   * Document size in bytes.
   */
  size?: number;
  /**
   * An URI to the local document file.
   */
  uri: string;
  /**
   * Document MIME type.
   */
  mimeType?: string;
  /**
   * Timestamp of last document modification. [Web API specs](https://developer.mozilla.org/en-US/docs/Web/API/File/lastModified)
   * The lastModified provides the last modified date of the file as the number
   * of milliseconds since the Unix epoch (January 1, 1970 at midnight). Files
   * without a known last modified date return the current date.
   */
  lastModified: number;
  /**
   * `File` object for the parity with web File API.
   * @platform web
   */
  file?: File;
  /**
   * Base64 string of the file.
   * @platform web
   */
  base64?: string;
};

/**
 * Type representing successful and canceled document pick result.
 */
export type DocumentPickerResult = DocumentPickerSuccessResult | DocumentPickerCanceledResult;

/**
 * Type representing successful pick result.
 */
export type DocumentPickerSuccessResult = {
  /**
   * If asset data have been returned this should always be `false`.
   */
  canceled: false;
  /**
   * An array of picked assets.
   */
  assets: DocumentPickerAsset[];
  /**
   * `FileList` object for the parity with web File API.
   * @platform web
   */
  output?: FileList;
};

/**
 * Type representing canceled pick result.
 */
export type DocumentPickerCanceledResult = {
  /**
   *  Always `true` when the request was canceled.
   */
  canceled: true;
  /**
   *  Always `null` when the request was canceled.
   */
  assets: null;
  /**
   * Always `null` when the request was canceled.
   * @platform web
   */
  output?: null;
};