Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EdgeFile

Helper class for tracking intent when creating a File object for uploading

Hierarchy

Index

Constructors

Methods

Properties

Accessors

Constructors

constructor

  • new EdgeFile(data?: any, fileFormat?: string, name?: string, createOpts?: {}, urlOpts?: string): EdgeFile

Methods

createFile

  • createFile(client: Client, force?: boolean): Promise<any>

  • Helper function to create the file on the server but not yet upload its data

    By default, this will skip recreating files that have already been created.

    Parameters

    • client: Client

      Client object to use for uploading

    • force: boolean = false

      If true, will force creation of a new ID even if file has already been uploaded

    Returns Promise<any>

setData

  • setData(data: any): void

  • Populate data for later uploading if it wasn't set during construction

    Cannot run this function if the file has already been uploaded

    Overwrites any existing data

    Parameters

    • data: any

      Data to use for uploading

    Returns void

upload

  • upload(client: Client, force?: boolean): Promise<File>

  • Upload curent File object to the server

    By default, this will skip reuploading files that have already been uploaded.

    Parameters

    • client: Client

      Client object to use for uploading

    • force: boolean = false

      If true, will force upload even if file has already been uploaded

    Returns Promise<File>

    Promise that resolves to the uploaded File object when it completes uploading

uploadData

  • uploadData(client: Client, force?: boolean): Promise<any>

  • Helper function to upload the data to the server

    By default, this will skip reuploading data that has already been uploaded.

    Parameters

    • client: Client

      Client object to use for uploading

    • force: boolean = false

      If true, will force upload even if file has already been uploaded

    Returns Promise<any>

Properties

Readonly createOpts

createOpts: Record<string, any>

Readonly fileFormat

fileFormat: string

Readonly name

name: string

Readonly type

type: FileType

Readonly uploadUrlOpts

uploadUrlOpts: string

Accessors

data

  • get data(): any

  • Returns any

fileCreateResponse

  • get fileCreateResponse(): any

  • Returns any

fileCreated

  • get fileCreated(): boolean

  • Returns boolean

fileID

  • get fileID(): undefined | string

  • Returns undefined | string

fileUploadResponse

  • get fileUploadResponse(): any

  • Returns any

fileUploaded

  • get fileUploaded(): any

  • Returns any