Skip to content

basalt / drives-dropbox/src / DropboxDriveOptions

Interface: DropboxDriveOptions ​

Defined in: drives-dropbox/src/provider.ts:105

Public surface of @basaltkit/drives-dropbox.

A barrel, and nothing else. The adapter itself lives in provider.ts so the workspace coverage gate — which excludes **​/index.ts on the assumption that a package's index.ts is a re-export file — actually measures it. That assumption holds for a satellite whose barrel is its driver; it did not hold here, where 400+ lines of OAuth, cursor and signature handling were sitting behind the exclusion.

Properties ​

clientId ​

> clientId: string

Defined in: drives-dropbox/src/provider.ts:107

App key from the Dropbox App Console.


clientSecret? ​

> optional clientSecret?: string

Defined in: drives-dropbox/src/provider.ts:116

App secret.

Optional: a public client uses PKCE alone. When present it is also the default webhook signing key, because Dropbox signs notifications with the app secret — there is no separate webhook secret to configure, and no per-connection secret at all.


now? ​

> optional now?: () => number

Defined in: drives-dropbox/src/provider.ts:128

Injected clock (tests).

Returns ​

number


pageSize? ​

> optional pageSize?: number

Defined in: drives-dropbox/src/provider.ts:122

list_folder page size. Clamped to 1…2000. Default 500.


recursive? ​

> optional recursive?: boolean

Defined in: drives-dropbox/src/provider.ts:124

Whether listings and the change feed walk subfolders. Default true.


scopes? ​

> optional scopes?: readonly string[]

Defined in: drives-dropbox/src/provider.ts:120

Scopes to request. Default: read-only metadata + content + account info.


uploadMaxBytes? ​

> optional uploadMaxBytes?: number

Defined in: drives-dropbox/src/provider.ts:126

Hard ceiling for one upload. Default — and maximum — 150 MB.


webhookSecret? ​

> optional webhookSecret?: string

Defined in: drives-dropbox/src/provider.ts:118

Overrides the webhook signing key. Only needed if the app secret is held elsewhere.

Released under the MIT License.