Kotlin Wrappers API Reference

kotlin-web/web.file/FileReader

FileReader

open class FileReader : EventTarget(source)

The FileReader interface lets web applications asynchronously read the contents of files (or raw data buffers) stored on the user's computer, using File or Blob objects to specify the file or data to read.

Constructors

constructor()

Types

object Companion

sealed interface ReadyState

Properties

val abortEvent: EventInstance<ProgressEvent, FileReader, FileReader>

val DONE: FileReader.ReadyState

val EMPTY: FileReader.ReadyState

val error: DOMException?

The error read-only property of the FileReader interface returns the error that occurred while reading the file.

val errorEvent: EventInstance<ProgressEvent, FileReader, FileReader>

val loadEndEvent: EventInstance<ProgressEvent, FileReader, FileReader>

val loadEvent: EventInstance<ProgressEvent, FileReader, FileReader>

val LOADING: FileReader.ReadyState

val loadStartEvent: EventInstance<ProgressEvent, FileReader, FileReader>

var onabort: EventHandler<ProgressEvent, FileReader, FileReader>?

var onerror: EventHandler<ProgressEvent, FileReader, FileReader>?

var onload: EventHandler<ProgressEvent, FileReader, FileReader>?

var onloadend: EventHandler<ProgressEvent, FileReader, FileReader>?

var onloadstart: EventHandler<ProgressEvent, FileReader, FileReader>?

var onprogress: EventHandler<ProgressEvent, FileReader, FileReader>?

val progressEvent: EventInstance<ProgressEvent, FileReader, FileReader>

val readyState: FileReader.ReadyState

The readyState read-only property of the FileReader interface provides the current state of the reading operation.

val result: JsAny?

The result read-only property of the FileReader interface returns the file's contents.

Functions

fun abort()

The abort() method of the FileReader interface aborts the read operation.

fun dispatchEvent(event: Event): Boolean

readAsArrayBuffer

fun readAsArrayBuffer(blob: Blob)

The readAsArrayBuffer() method of the FileReader interface is used to start reading the contents of a specified Blob or File.

fun readAsDataURL(blob: Blob)

The readAsDataURL() method of the FileReader interface is used to read the contents of the specified file's data as a base64 encoded string.

fun readAsText(blob: Blob, encoding: String = definedExternally)

The readAsText() method of the FileReader interface is used to read the contents of the specified Blob or File.

fun <T : Event> when(type: EventType<T>, options: ObservableEventListenerOptions? = definedExternally): Observable<T>