Drivers Interface

Complete reference of the Driver interface that all drivers must implement.

Driver Interface

export interface Driver {
  configureUploader?: (uppy: any, context: UploaderContext) => void;
  list(params?: ListParams): Promise<FsData>;
  delete(params: DeleteParams): Promise<DeleteResult>;
  rename(params: RenameParams): Promise<FileOperationResult>;
  copy(params: TransferParams): Promise<FileOperationResult>;
  move(params: TransferParams): Promise<FileOperationResult>;
  archive(params: ArchiveParams): Promise<FileOperationResult>;
  unarchive(params: { item: string; path: string }): Promise<FileOperationResult>;
  createFile(params: { path: string; name: string }): Promise<FileOperationResult>;
  createFolder(params: { path: string; name: string }): Promise<FileOperationResult>;
  getContent(params: { path: string }): Promise<FileContentResult>;
  getPreviewUrl(params: { path: string }): string;
  getDownloadUrl(params: { path: string }): string;
  search(params: SearchParams): Promise<DirEntry[]>;
  save(params: SaveParams): Promise<string>;
}

Built-in drivers

VueFinder ships with ready-to-use drivers that implement this interface:

ArrayDriver — In-memory, array-backed storage for demos/tests
IndexedDBDriver — Browser-persistent storage using IndexedDB
RemoteDriver — HTTP API backend integration

See the guide for usage and configuration of these drivers: Guide - Drivers & Adapters

Method Details

`list`

List files and folders in a directory.

Parameters:

params?: ListParams - Optional parameters including path

Returns: Promise<FsData> - File system data with files array

`delete`

Delete files or folders.

Parameters:

params: DeleteParams - Delete parameters

Returns: Promise<DeleteResult> - Result with deleted items