Class Upload

General purpose class for uploading blobs to drives

Hierarchy

  • EventEmitter<EventMap>
    • Upload

Constructors

constructor

Properties

basePath blobs complete drive errors files running servers signer status prefixed

Accessors

progress

Methods

addFile addFileList addFileSystemEntry addListener emit eventNames listenerCount listeners off on once removeAllListeners removeListener upload

Constructors

constructor

Properties

basePath

basePath: string

The base path in the drive to add all the files to

blobs

blobs: Record<string, Record<string, BlobDescriptor>> = {}

The Blobs returned for each file upload, blobs[server][file.id]

complete

complete: boolean = false

drive

drive: Drive | EncryptedDrive

errors

errors: Record<string, Record<string, Error>> = {}

The Error returned for each file upload, blobs[server][file.id]

files

files: {
    file: File;
    id: string;
    path: string;
}[] = []

The array of files to upload to the drive

Type declaration

  • file: File
  • id: string
  • path: string

running

running: boolean = false

servers

servers: string[]

The array of blossom servers to upload the files to

signer

signer: Signer

The signer used to sign auth events

status

status: Record<string, UploadFileStatus> = {}

Current upload status for each file

Static prefixed

prefixed: string | boolean

Accessors

progress

  • get progress(): number

  • Total upload progress

    Returns number

Methods

addFile

  • addFile(file, path?): Promise<void>

  • Add a single file to the upload

    Parameters

    • file: File
    • Optional path: string

    Returns Promise<void>

addFileList

  • addFileList(fileList): Promise<void>

  • Add a FileList to the upload

    Parameters

    • fileList: FileList

    Returns Promise<void>

addFileSystemEntry

  • addFileSystemEntry(entry): Promise<void>

  • Read all files from a FileSystemEntry and add to the upload

    Parameters

    • entry: FileSystemEntry

    Returns Promise<void>

addListener

  • addListener<T>(event, fn, context?): this

  • Type Parameters

    • T extends keyof EventMap

    Parameters

    • event: T
    • fn: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: ArgumentMap<EventMap>[Extract<T, keyof EventMap>]

          Returns void

    • Optional context: any

    Returns this

emit

  • emit<T>(event, ...args): boolean

  • Calls each of the listeners registered for a given event.

    Type Parameters

    • T extends keyof EventMap

    Parameters

    • event: T
    • Rest ...args: ArgumentMap<EventMap>[Extract<T, keyof EventMap>]

    Returns boolean

eventNames

  • eventNames(): (keyof EventMap)[]

  • Return an array listing the events for which the emitter has registered listeners.

    Returns (keyof EventMap)[]

listenerCount

  • listenerCount(event): number

  • Return the number of listeners listening to a given event.

    Parameters

    • event: keyof EventMap

    Returns number

listeners

  • listeners<T>(event): ((...args) => void)[]

  • Return the listeners registered for a given event.

    Type Parameters

    • T extends keyof EventMap

    Parameters

    • event: T

    Returns ((...args) => void)[]

off

  • off<T>(event, fn?, context?, once?): this

  • Type Parameters

    • T extends keyof EventMap

    Parameters

    • event: T
    • Optional fn: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: ArgumentMap<EventMap>[Extract<T, keyof EventMap>]

          Returns void

    • Optional context: any
    • Optional once: boolean

    Returns this

on

  • on<T>(event, fn, context?): this

  • Add a listener for a given event.

    Type Parameters

    • T extends keyof EventMap

    Parameters

    • event: T
    • fn: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: ArgumentMap<EventMap>[Extract<T, keyof EventMap>]

          Returns void

    • Optional context: any

    Returns this

once

  • once<T>(event, fn, context?): this

  • Add a one-time listener for a given event.

    Type Parameters

    • T extends keyof EventMap

    Parameters

    • event: T
    • fn: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: ArgumentMap<EventMap>[Extract<T, keyof EventMap>]

          Returns void

    • Optional context: any

    Returns this

removeAllListeners

  • removeAllListeners(event?): this

  • Remove all listeners, or those of the specified event.

    Parameters

    • Optional event: keyof EventMap

    Returns this

removeListener

  • removeListener<T>(event, fn?, context?, once?): this

  • Remove the listeners of a given event.

    Type Parameters

    • T extends keyof EventMap

    Parameters

    • event: T
    • Optional fn: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: ArgumentMap<EventMap>[Extract<T, keyof EventMap>]

          Returns void

    • Optional context: any
    • Optional once: boolean

    Returns this

upload

  • upload(): Promise<void>

  • Start uploading the files to the servers

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

constructorbasePathblobscompletedriveerrorsfilesrunningserverssignerstatusprefixedprogressaddFileaddFileListaddFileSystemEntryaddListeneremiteventNameslistenerCountlistenersoffononceremoveAllListenersremoveListenerupload

Generated using TypeDoc