CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Class

FileReader (upload)

@ckeditor/ckeditor5-upload/src/filereader

class
See source

Wrapper over the native FileReader.

Filtering

Properties

  • data : File | undefined

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

    See source

  • error

    Returns error that occurred during file reading.

    See source

  • loaded : Number

    readonly observable

    Number of bytes loaded.

    See source

  • _reader : FileReader

    private

    Instance of native FileReader.

    See source

Methods

  • constructor()

    Creates an instance of the FileReader.

    See source

  • abort()

    Aborts file reader.

    See source

  • read( file ) → Promise.<String>

    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 )

    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.