Class DropboxFS

Hierarchy

  • CloudFS<DBReject>
    • DropboxFS

Constructors

constructor

Properties

_mountPoint? _sync? _uuid attributes cacheTTL client convertError label? name partialCache type

Accessors

uuid

Methods

_create _delete _move _read _stat _touch? _write createFile createFileSync exists existsSync getValidContents link linkSync mkdir mkdirSync queueDone read readdir readdirSync readSync ready rename renameSync rmdir rmdirSync stat statSync streamRead streamWrite sync syncSync toString touch touchSync 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

Protected Internal_uuid

_uuid: `${string}-${string}-${string}-${string}-${string}`

The UUID of the file system.

Readonlyattributes

attributes: ConstMap<FileSystemAttributes, keyof FileSystemAttributes, void> & Map<
    string,
    any,
>

See

FileSystemAttributes

ReadonlycacheTTL

cacheTTL: number = 3600

Readonlyclient

client: Dropbox

ProtectedconvertError

convertError: (error: DBReject, message?: string) => Exception

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> = ...

Readonlytype

type: number

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

Accessors

uuid

  • get uuid(): `${string}-${string}-${string}-${string}-${string}`

  • Returns `${string}-${string}-${string}-${string}-${string}`

Methods

Protected_create

  • _create(path: string, inode: Inode): Promise<void>

  • Parameters

    • path: string
    • inode: Inode

    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<Inode>

  • Parameters

    • path: string

    Returns Promise<Inode>

Protected Optional_touch

  • _touch(path: string, inode: Partial<InodeLike>): Promise<void>

  • Parameters

    • path: string
    • inode: Partial<InodeLike>

    Returns Promise<void>

Protected_write

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

  • Parameters

    • path: string
    • buffer: Uint8Array

    Returns Promise<void>

createFile

  • createFile(path: string, options: CreationOptions): Promise<Inode>

  • Create the file at path with the given options.

    Parameters

    • path: string
    • options: CreationOptions

    Returns Promise<Inode>

AbstractcreateFileSync

  • createFileSync(path: string, options: CreationOptions): InodeLike

  • Create the file at path with the given options.

    Parameters

    • path: string
    • options: CreationOptions

    Returns InodeLike

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(): Promise<void>

  • Returns Promise<void>

AbstractlinkSync

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

  • Parameters

    • target: string
    • link: string

    Returns void

mkdir

  • mkdir(path: string, options: CreationOptions): Promise<Inode>

  • Parameters

    • path: string
    • options: CreationOptions

    Returns Promise<Inode>

AbstractmkdirSync

  • mkdirSync(path: string, options: CreationOptions): InodeLike

  • Parameters

    • path: string
    • options: CreationOptions

    Returns InodeLike

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
    • 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, start: 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!

    • start: 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<InodeLike>

  • Parameters

    • path: string

    Returns Promise<InodeLike>

AbstractstatSync

  • statSync(path: string): InodeLike

  • Parameters

    • path: string

    Returns InodeLike

streamRead

  • streamRead(path: string, options: StreamOptions): ReadableStream

  • Read a file using a stream.

    Parameters

    • path: string
    • options: StreamOptions

    Returns ReadableStream

streamWrite

  • streamWrite(path: string, options: StreamOptions): WritableStream

  • Write a file using stream.

    Parameters

    • path: string
    • options: StreamOptions

    Returns WritableStream

sync

  • sync(): Promise<void>

  • Returns Promise<void>

AbstractsyncSync

  • syncSync(): void

  • Returns void

toString

  • toString(): string

  • Returns string

touch

  • touch(path: string, metadata?: Partial<InodeLike>): Promise<void>

  • Modify metadata.

    Parameters

    • path: string
    • metadata: Partial<InodeLike> = {}

    Returns Promise<void>

AbstracttouchSync

  • touchSync(path: string, metadata: Partial<InodeLike>): void

  • Modify metadata.

    Parameters

    • path: string
    • metadata: Partial<InodeLike>

    Returns void

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
Accessors
Methods