karet.fr

An observable wrapper for XMLHttpRequest using Kefir

Usage no npm install needed!

<script type="module">
  import karetFr from 'https://cdn.skypack.dev/karet.fr';
</script>

README

Karet FR · Gitter GitHub stars

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

Examples:

npm version Build Status Code Coverage

Contents

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