expo-updates/src/Updates.types.ts

Fetches and manages remotely-hosted assets and updates to your app's JS bundle.

import Constants from 'expo-constants';

/**
 * The types of update-related events.
 */
export enum UpdateEventType {
  /**
   * A new update has finished downloading to local storage. If you would like to start using this
   * update at any point before the user closes and restarts the app on their own, you can call
   * [`Updates.reloadAsync()`](#reloadasync) to launch this new update.
   */
  UPDATE_AVAILABLE = 'updateAvailable',
  /**
   * No updates are available, and the most up-to-date update is already running.
   */
  NO_UPDATE_AVAILABLE = 'noUpdateAvailable',
  /**
   * An error occurred trying to fetch the latest update.
   */
  ERROR = 'error',
}

// @docsMissing
// TODO(eric): move source of truth for manifest type to this module
/**
 * @hidden
 */
export type ClassicManifest = typeof Constants.manifest;

// @docsMissing
/**
 * @hidden
 */
export type Manifest = ClassicManifest | typeof Constants.manifest2;
// modern manifest type is intentionally not exported, since the plan is to call it just "Manifest"
// in the future

/**
 * The result of checking for a new update.
 */
export type UpdateCheckResult = {
  /**
   * `true` if an update is available, `false` if the app is already running the latest available
   * update.
   */
  isAvailable: boolean;
  /**
   * If `isAvailable` is `true`, the manifest of the available update, and `undefined` otherwise.
   */
  manifest?: Manifest;
};

/**
 * The result of fetching a new update.
 */
export type UpdateFetchResult = {
  /**
   * `true` if the fetched bundle is new (that is, a different version than what's currently
   * running), `false` otherwise.
   */
  isNew: boolean;
  /**
   * If `isNew` is `true`, the manifest of the newly downloaded update, and `undefined` otherwise.
   */
  manifest?: Manifest;
};

/**
 * An object that is passed into each event listener when an auto-update check occurs.
 */
export type UpdateEvent = {
  /**
   * Type of the event.
   */
  type: UpdateEventType;
  /**
   * If `type` is `Updates.UpdateEventType.UPDATE_AVAILABLE`, the manifest of the newly downloaded
   * update, and `undefined` otherwise.
   */
  manifest?: Manifest;
  /**
   * If `type` is `Updates.UpdateEventType.ERROR`, the error message, and `undefined` otherwise.
   */
  message?: string;
};

// @docsMissing
/**
 * @hidden
 */
export type LocalAssets = Record<string, string>;