createDropboxProviderFactory

function createDropboxProviderFactory(options?: DropboxProviderOptions): ProviderFactory;

Defined in: src/providers/cloud/DropboxProvider.ts:128

Creates a Dropbox provider factory.

The bearer token is resolved per-connection from profile.password. The profile.host field is unused; Dropbox connections are identified solely by their token. Large uploads stream through chunked upload sessions (upload_session/start + append_v2 + finish); payloads at or below the threshold use single-shot /2/files/upload.

Parameters

Parameter	Type	Description
options	DropboxProviderOptions	Optional API base URL overrides, upload-session tuning, and fetch implementation.

Returns

ProviderFactory

Provider factory suitable for createTransferClient({ providers: [...] }).

Example

import { createDropboxProviderFactory, createTransferClient, uploadFile } from "@zero-transfer/sdk";

const client = createTransferClient({ providers: [createDropboxProviderFactory()] });

await uploadFile({
  client,
  localPath: "./backups/db.dump",
  destination: {
    path: "/Backups/2026-04-28/db.dump",
    profile: {
      host: "",
      provider: "dropbox",
      password: { env: "DROPBOX_ACCESS_TOKEN" },
    },
  },
});