# Dropbox API reference

> Exports of @anymux/dropbox.

Source: https://anymux-docs.n.yatsyk.com/docs/dropbox/jsdoc

## Classes

### DropboxFileSystem

```ts
class DropboxFileSystem
```

- `promises: this`
- `constants: FSConstants`
- `constructor(config: DropboxConfig): DropboxFileSystem`
- `readFile(path: string, options?: { encoding?: BufferEncoding; flag?: string; } | BufferEncoding): Promise<Buffer | string>`
- `writeFile(path: string, data: Buffer | string | Uint8Array, _options?: { encoding?: BufferEncoding; mode?: number; flag?: string; }): Promise<void>`
- `appendFile(path: string, data: Buffer | string | Uint8Array, options?: { encoding?: BufferEncoding; mode?: number; flag?: string; }): Promise<void>`
- `stat(path: string, options?: { bigint?: false; }): Promise<Stats>`
- `stat(path: string, options: { bigint: true; }): Promise<BigIntStats>`
- `stat(path: string, _options?: { bigint?: boolean; }): Promise<Stats | BigIntStats>`
- `readdir(path: string, options?: { encoding?: BufferEncoding; withFileTypes?: false; recursive?: boolean; }): Promise<string[]>`
- `readdir(path: string, options: { encoding?: BufferEncoding; withFileTypes: true; recursive?: boolean; }): Promise<Dirent[]>`
- `readdir(path: string, options?: { encoding?: BufferEncoding; withFileTypes?: boolean; recursive?: boolean; }): Promise<string[] | Dirent[]>`
- `mkdir(path: string, options?: { recursive?: boolean; mode?: number; }): Promise<string | undefined>`
- `unlink(path: string): Promise<void>`
- `rmdir(path: string, _options?: { maxRetries?: number; recursive?: boolean; retryDelay?: number; }): Promise<void>`
- `rm(path: string, options?: { force?: boolean; maxRetries?: number; recursive?: boolean; retryDelay?: number; }): Promise<void>`
- `rename(oldPath: string, newPath: string): Promise<void>`
- `copyFile(src: string, dest: string, _mode?: number): Promise<void>`
- `access(path: string, _mode?: number): Promise<void>`
- `exists(path: string): Promise<boolean>`
- `lstat(path: string, options?: { bigint?: false; }): Promise<Stats>`
- `lstat(path: string, options: { bigint: true; }): Promise<BigIntStats>`
- `lstat(_path: string, _options?: { bigint?: boolean; }): Promise<Stats | BigIntStats>`
- `chmod(_path: string, _mode: string | number): Promise<void>`
- `chown(_path: string, _uid: number, _gid: number): Promise<void>`
- `readlink(_path: string, _options?: { encoding?: BufferEncoding; }): Promise<string>`
- `symlink(_target: string, _path: string, _type?: "dir" | "file" | "junction"): Promise<void>`
- `link(_existingPath: string, _newPath: string): Promise<void>`
- `truncate(_path: string, _len?: number): Promise<void>`
- `utimes(_path: string, _atime: string | number | Date, _mtime: string | number | Date): Promise<void>`
- `createReadStream(_path: string, _options?: { encoding?: BufferEncoding; start?: number; end?: number; }): ReadStream`
- `createWriteStream(_path: string, _options?: { encoding?: BufferEncoding; flags?: string; mode?: number; }): WriteStream`
- `watch(_path: string, _options?: { encoding?: BufferEncoding; persistent?: boolean; recursive?: boolean; }): FSWatcher`
- `open(_path: string, _flags?: string | number, _mode?: number): Promise<IFileHandle>`
- `opendir(_path: string, _options?: { encoding?: BufferEncoding; bufferSize?: number; recursive?: boolean; }): Promise<IDir>`
- `realpath(_path: string, _options?: { encoding?: BufferEncoding; }): Promise<string>`
- `cp(_src: string, _dest: string, _options?: { dereference?: boolean; errorOnExist?: boolean; filter?: (src: string, dest: string) => boolean | Promise<boolean>; force?: boolean; mode?: number; preserveTimestamps?: boolean; recursive?: boolean; verbatimSymlinks?: boolean; }): Promise<void>`
- `mkdtemp(_prefix: string, _options?: { encoding?: BufferEncoding; }): Promise<string>`
- `statfs(path: string, options?: { bigint?: false; }): Promise<StatFs>`
- `statfs(path: string, options: { bigint: true; }): Promise<BigIntStatFs>`
- `statfs(_path: string, _options?: { bigint?: boolean; }): Promise<StatFs | BigIntStatFs>`
- `lutimes(_path: string, _atime: string | number | Date, _mtime: string | number | Date): Promise<void>`
- `lchown(_path: string, _uid: number, _gid: number): Promise<void>`
- `lchmod(_path: string, _mode: string | number): Promise<void>`
- `isImplemented(method: string): boolean`

## Types

### DropboxConfig

```ts
type DropboxConfig = { accessToken?: string; rootPath?: string; }
```

## Constants

### DropboxConfigSchema

```ts
const DropboxConfigSchema: z.ZodObject<{ accessToken: z.ZodString; rootPath: z.ZodDefault<z.ZodOptional<z.ZodString>>; }, "strip", z.ZodTypeAny, { accessToken?: string; rootPath?: string; }, { accessToken?: string; rootPath?: string; }>
```