FileReader (upload)

@ckeditor/ckeditor5-upload/src/filereader

Properties

• data : File | undefinedmodule:upload/filereader~FileReader#data

  Holds the data of an already loaded file. The file must be first loaded by using read().

  See source

• errormodule:upload/filereader~FileReader#error

  Returns error that occurred during file reading.

  See source

• loaded : Numbermodule:upload/filereader~FileReader#loaded

  readonly observable

  Number of bytes loaded.

  See source

• _reader : FileReadermodule:upload/filereader~FileReader#_reader

  private

  Instance of native FileReader.

  See source

Methods

• constructor()module:upload/filereader~FileReader#constructor

  Creates an instance of the FileReader.

  See source

• abort()module:upload/filereader~FileReader#abort

  Aborts file reader.

  See source

• read( file ) → Promise.<String>module:upload/filereader~FileReader#read

  Reads the provided file.

  See source

  Parameters

  file : File

  Native File object.

  Returns

  Promise.<String>

  Returns a promise that will be resolved with file's content. The promise will be rejected in case of an error or when the reading process is aborted.

Events

• change:loaded( eventInfo, name, value, oldValue )module:upload/filereader~FileReader#event:change:loaded

  Fired when the loaded property changed value.

  See source

  Parameters

  eventInfo : EventInfo

  An object containing information about the fired event.

  name : String

  Name of the changed property (loaded).

  value : Number

  New value of the loaded property with given key or null, if operation should remove property.

  oldValue : Number

  Old value of the loaded property with given key or null, if property was not set before.