Interface MediaStore

packages/tinacms/src/toolkit/core/media.ts:65–117

 * managing media.
 */
export interface MediaStore {
  /**
   * The [input accept string](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#accept)
   * that describes what kind of files the Media Store will accept.
   */
  accept: string;

  /**
   * The maximum size of a file that can be uploaded.
   */
  maxSize?: number;

  /**
   * Uploads a set of files to the Media Store and
   * returns a Promise containing the Media objects
   * for those files.
   */
  persist(files: MediaUploadOptions[]): Promise<Media[]>;

  /**
   * Delete a media object from the store.
   */
  delete(media: Media): Promise<void>;

  /**
   * Lists all media in a specific directory.
   */
  list(options?: MediaListOptions): Promise<MediaList>;

  /**
   * Reserved hook for renaming a media object in the store.
   *
   * Not yet implemented in `TinaMediaStore` or surfaced in `MediaManager` —
   * declared here as an extension point so stores can begin to opt in once
   * the corresponding assets-api endpoint is built.
   */
  rename?(from: string, to: string): Promise<Media>;

  /**
   * Indicates that uploads and deletions are not supported
   *
   * @default false
   */
  isStatic?: boolean;

  /**
   * Converts a Media object to the value stored in a form field.
   *
   * Typically returns `media.src`. If not implemented, the image field
   * plugin falls back to `media.src`.
   */
  parse?(media: Media): string;
}

export declare type MediaListOffset = string | number;
/**