karet.fr v0.1.0

≡ Karet FR ·

This library provides a thin wrapper over the standard FileReader API. See also Karet XHR.

Examples:

• Live Image Upload CodeSandbox.

≡ Contents

• Reference
  • Starting
    • FR.readAsArrayBuffer(file) ~> fileReader
    • FR.readAsBinaryString(file) ~> fileReader
    • FR.readAsDataURL(file) ~> fileReader
    • FR.readAsText(file) ~> fileReader
  • State
    • FR.hasEnded(fileReader) ~> boolean
    • FR.hasFailed(fileReader) ~> boolean
    • FR.hasStarted(fileReader) ~> boolean
    • FR.hasSucceeded(fileReader) ~> boolean
    • FR.isDone(fileReader) ~> boolean
    • FR.isProgressing(fileReader) ~> boolean
    • FR.loaded(fileReader) ~> number
    • FR.readyState(fileReader) ~> number
    • FR.total(fileReader) ~> number
  • Result
    • FR.result(fileReader) ~> varies
    • FR.error(fileReader) ~> exception

≡ Reference

The interface of this library consists of named exports. Typically one just imports the library as:

import * as FR from 'karet.fr'

≡ Starting

≡ FR.readAsArrayBuffer(file) ~> fileReader

≡ FR.readAsBinaryString(file) ~> fileReader

≡ FR.readAsDataURL(file) ~> fileReader

≡ FR.readAsText(file) ~> fileReader

≡ State

≡ FR.hasEnded(fileReader) ~> boolean

≡ FR.hasFailed(fileReader) ~> boolean

≡ FR.hasStarted(fileReader) ~> boolean

≡ FR.hasSucceeded(fileReader) ~> boolean

≡ FR.isDone(fileReader) ~> boolean

≡ FR.isProgressing(fileReader) ~> boolean

≡ FR.loaded(fileReader) ~> number

≡ FR.readyState(fileReader) ~> number

≡ FR.total(fileReader) ~> number

≡ Result

≡ FR.result(fileReader) ~> varies

≡ FR.error(fileReader) ~> exception