ZenFS Cloud
    Preparing search index...

    Class DropboxFS

    Hierarchy

    • CloudFS<DBReject>
      • DropboxFS
    Index

    Constructors

    • Parameters

      • client: Dropbox
      • OptionalcacheTTL: number

      Returns DropboxFS

    Properties

    _mountPoint?: string

    The last place this file system was mounted

    _sync?: FileSystem
    _uuid: `${string}-${string}-${string}-${string}-${string}`

    The UUID of the file system.

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

    FileSystemAttributes

    cacheTTL: number = 3600
    client: Dropbox
    convertError: (error: DBReject, message?: string) => Exception
    label?: string
    name: string

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

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

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

    Accessors

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

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

    Methods

    • Parameters

      • path: string
      • inode: Inode

      Returns Promise<void>

    • Parameters

      • path: string

      Returns Promise<void>

    • Parameters

      • from: string
      • to: string

      Returns Promise<void>

    • Parameters

      • path: string

      Returns Promise<Uint8Array<ArrayBufferLike>>

    • Parameters

      • path: string

      Returns Promise<Inode>

    • Parameters

      • path: string
      • inode: Partial<InodeLike>

      Returns Promise<void>

    • Parameters

      • path: string
      • buffer: Uint8Array

      Returns Promise<void>

    • Create the file at path with the given options.

      Parameters

      • path: string
      • options: CreationOptions

      Returns Promise<Inode>

    • Create the file at path with the given options.

      Parameters

      • path: string
      • options: CreationOptions

      Returns InodeLike

    • Test whether or not path exists.

      Parameters

      • path: string

      Returns Promise<boolean>

    • Test whether or not path exists.

      Parameters

      • path: string

      Returns boolean

    • Parameters

      • path: string
      • syscall: string

      Returns Promise<Uint8Array<ArrayBufferLike>>

    • Returns Promise<void>

    • Parameters

      • target: string
      • link: string

      Returns void

    • Parameters

      • path: string
      • options: CreationOptions

      Returns Promise<Inode>

    • Parameters

      • path: string
      • options: CreationOptions

      Returns InodeLike

    • Returns Promise<void>

      Use sync instead

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

    • Parameters

      • path: string

      Returns Promise<string[]>

    • Parameters

      • path: string

      Returns string[]

    • 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

    • Returns Promise<void>

      Use sync instead

    • Parameters

      • oldPath: string
      • newPath: string

      Returns Promise<void>

    • Parameters

      • oldPath: string
      • newPath: string

      Returns void

    • Parameters

      • path: string

      Returns Promise<void>

    • Parameters

      • path: string

      Returns void

    • Parameters

      • path: string

      Returns Promise<InodeLike>

    • Parameters

      • path: string

      Returns InodeLike

    • Read a file using a stream.

      Parameters

      • path: string
      • options: StreamOptions

      Returns ReadableStream

    • Write a file using stream.

      Parameters

      • path: string
      • options: StreamOptions

      Returns WritableStream

    • Returns Promise<void>

    • Returns void

    • Returns string

    • Modify metadata.

      Parameters

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

      Returns Promise<void>

    • Modify metadata.

      Parameters

      • path: string
      • metadata: Partial<InodeLike>

      Returns void

    • Parameters

      • path: string

      Returns Promise<void>

    • Parameters

      • path: string

      Returns void

    • Experimental

      Default implementation.

      Returns UsageInfo

      Implement

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

    • 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