Class DropboxFS

Hierarchy

  • CloudFS<DBReject>
    • DropboxFS

Constructors

constructor

Properties

_mountPoint? _sync? attributes cacheTTL client convertError id label? name partialCache

Methods

_create _delete _move _read _stat _write createFile createFileSync exists existsSync getValidContents link linkSync metadata mkdir mkdirSync openFile openFileSync queueDone read readdir readdirSync readSync ready rename renameSync rmdir rmdirSync stat statSync sync syncSync toString unlink unlinkSync usage write writeSync

Constructors

constructor

  • new DropboxFS(client: Dropbox, cacheTTL?: number): DropboxFS

  • Parameters

    • client: Dropbox
    • OptionalcacheTTL: number

    Returns DropboxFS

Properties

Protected Optional Internal_mountPoint

_mountPoint?: string

The last place this file system was mounted

Protected Optional Internal_sync

_sync?: FileSystem

Readonlyattributes

attributes: ConstMap<FileSystemAttributes, keyof FileSystemAttributes, void>

See

FileSystemAttributes

ReadonlycacheTTL

cacheTTL: number = 3600

Readonlyclient

client: Dropbox

ProtectedconvertError

convertError: (
    error: DBReject,
    path: string,
    syscall: string,
    message?: string,
) => ErrnoError

Readonlyid

id: number

A unique ID for this kind of file system. Currently unused internally, but could be used for partition tables or something

Optionallabel

label?: string

Readonlyname

name: string

The name for this file system. For example, tmpfs for an in memory one

ProtectedpartialCache

partialCache: Map<string, CacheEntry> = ...

Methods

Protected_create

  • _create(path: string, stats: Stats): Promise<void>

  • Parameters

    • path: string
    • stats: Stats

    Returns Promise<void>

Protected_delete

  • _delete(path: string): Promise<void>

  • Parameters

    • path: string

    Returns Promise<void>

_move

  • _move(from: string, to: string): Promise<void>

  • Parameters

    • from: string
    • to: string

    Returns Promise<void>

Protected_read

  • _read(path: string): Promise<Uint8Array>

  • Parameters

    • path: string

    Returns Promise<Uint8Array>

_stat

  • _stat(path: string): Promise<Stats>

  • Parameters

    • path: string

    Returns Promise<Stats>

Protected_write

  • _write(
        path: string,
        buffer: Uint8Array,
        stats: Partial<InodeLike>,
    ): Promise<void>

  • Parameters

    • path: string
    • buffer: Uint8Array
    • stats: Partial<InodeLike>

    Returns Promise<void>

createFile

  • createFile(path: string, flag: string, mode: number): Promise<File>

  • Create the file at path with the given options. Then, open it with flag.

    Parameters

    • path: string
    • flag: string
    • mode: number

    Returns Promise<File>

AbstractcreateFileSync

  • createFileSync(
        path: string,
        flag: string,
        mode: number,
        options: CreationOptions,
    ): File

  • Create the file at path with the given options. Then, open it with flag.

    Parameters

    • path: string
    • flag: string
    • mode: number
    • options: CreationOptions

    Returns File

exists

  • exists(path: string): Promise<boolean>

  • Test whether or not path exists.

    Parameters

    • path: string

    Returns Promise<boolean>

existsSync

  • existsSync(path: string): boolean

  • Test whether or not path exists.

    Parameters

    • path: string

    Returns boolean

ProtectedgetValidContents

  • getValidContents(path: string, syscall: string): Promise<Uint8Array>

  • Parameters

    • path: string
    • syscall: string

    Returns Promise<Uint8Array>

link

  • link(target: string): Promise<void>

  • Parameters

    • target: string

    Returns Promise<void>

AbstractlinkSync

  • linkSync(target: string, link: string): void

  • Parameters

    • target: string
    • link: string

    Returns void

metadata

  • metadata(): FileSystemMetadata

  • Get metadata about the current file system

    Returns FileSystemMetadata

    Deprecated

mkdir

  • mkdir(path: string, mode: number): Promise<void>

  • Parameters

    • path: string
    • mode: number

    Returns Promise<void>

AbstractmkdirSync

  • mkdirSync(path: string, mode: number, options: CreationOptions): void

  • Parameters

    • path: string
    • mode: number
    • options: CreationOptions

    Returns void

openFile

  • openFile(path: string, flag: string): Promise<File>

  • Opens the file at path with flag. The file must exist.

    Parameters

    • path: string

      The path to open.

    • flag: string

      The flag to use when opening the file.

    Returns Promise<File>

AbstractopenFileSync

  • openFileSync(path: string, flag: string): File

  • Opens the file at path with flag. The file must exist.

    Parameters

    • path: string

      The path to open.

    • flag: string

      The flag to use when opening the file.

    Returns File

queueDone

  • queueDone(): Promise<void>

  • Returns Promise<void>

read

  • read(
        path: string,
        buffer: Uint8Array,
        offset: number,
        end: number,
    ): Promise<void>

  • Reads into a buffer

    Parameters

    • path: string
    • buffer: Uint8Array

      The buffer to read into. You must set the byteOffset and byteLength appropriately!

    • offset: number

      The offset into the file to start reading from

    • end: number

      The position in the file to stop reading

    Returns Promise<void>

readdir

  • readdir(path: string): Promise<string[]>

  • Parameters

    • path: string

    Returns Promise<string[]>

AbstractreaddirSync

  • readdirSync(path: string): string[]

  • Parameters

    • path: string

    Returns string[]

AbstractreadSync

  • readSync(path: string, buffer: Uint8Array, offset: number, end: number): void

  • Reads into a buffer

    Parameters

    • path: string
    • buffer: Uint8Array

      The buffer to read into. You must set the byteOffset and byteLength appropriately!

    • offset: number

      The offset into the file to start reading from

    • end: number

      The position in the file to stop reading

    Returns void

ready

  • ready(): Promise<void>

  • Returns Promise<void>

rename

  • rename(oldPath: string, newPath: string): Promise<void>

  • Parameters

    • oldPath: string
    • newPath: string

    Returns Promise<void>

AbstractrenameSync

  • renameSync(oldPath: string, newPath: string): void

  • Parameters

    • oldPath: string
    • newPath: string

    Returns void

rmdir

  • rmdir(path: string): Promise<void>

  • Parameters

    • path: string

    Returns Promise<void>

AbstractrmdirSync

  • rmdirSync(path: string): void

  • Parameters

    • path: string

    Returns void

stat

  • stat(path: string): Promise<Stats>

  • Parameters

    • path: string

    Returns Promise<Stats>

AbstractstatSync

  • statSync(path: string): Stats

  • Parameters

    • path: string

    Returns Stats

sync

  • sync(path: string, data: Uint8Array, stats?: Partial<InodeLike>): Promise<void>

  • Parameters

    • path: string
    • data: Uint8Array
    • stats: Partial<InodeLike> = {}

    Returns Promise<void>

AbstractsyncSync

  • syncSync(
        path: string,
        data?: Uint8Array,
        stats?: Readonly<Partial<StatsLike>>,
    ): void

  • Parameters

    • path: string
    • Optionaldata: Uint8Array
    • Optionalstats: Readonly<Partial<StatsLike>>

    Returns void

toString

  • toString(): string

  • Returns string

unlink

  • unlink(path: string): Promise<void>

  • Parameters

    • path: string

    Returns Promise<void>

AbstractunlinkSync

  • unlinkSync(path: string): void

  • Parameters

    • path: string

    Returns void

usage

  • usage(): UsageInfo
  • Experimental

    Default implementation.

    Returns UsageInfo

    Todo

    Implement

write

  • write(path: string, data: Uint8Array, offset?: number): Promise<void>

  • Writes a buffer to a file

    Parameters

    • path: string
    • data: Uint8Array
    • offset: number = 0

      The offset in the file to start writing

    Returns Promise<void>

AbstractwriteSync

  • writeSync(path: string, buffer: Uint8Array, offset: number): void

  • Writes a buffer to a file

    Parameters

    • path: string
    • buffer: Uint8Array

      The buffer to write. You must set the byteOffset and byteLength appropriately!

    • offset: number

      The offset in the file to start writing

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods