# readerjs

> A tiny unified data reader interface for AJAX, local and File API access.

Latest version **0.0.3** (published 2013-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install readerjs
pnpm add readerjs
yarn add readerjs
bun add readerjs
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2013-11-07 |
| First published | 2013-11-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 14 |
| Author | 43081j |
| Maintainers | 43081j |

## Links

- npm: https://www.npmjs.com/package/readerjs
- Repository: https://github.com/43081j/reader.js
- Issues: https://github.com/43081j/reader.js/issues
- npm.io page: https://npm.io/package/readerjs

## Recent versions

- 0.0.3 (latest) — 2013-11-07
- 0.0.2 — 2013-11-03

## README

Reader.js
===

**Reader.js** is a tiny interface to unify three primary methods of reading data with JavaScript: AJAX requests, local disk access (NodeJS) and the HTML5 File API.

Example
===

```javascript
var rd = new Reader(Reader.OPEN_FILE);
rd.open(file, function() {
	// file has now been opened and is ready for reading
	rd.read(1024, function(err, data) {
		// data is now an ArrayBuffer
	});
});
```

Here, `data` will be an `ArrayBuffer` containing the first 1024 bytes from the specified file (which is a `File` instance).

The following types exist:

* `Reader.OPEN_FILE` Treat the specified object as a `File` instance (HTML5 File API)
* `Reader.OPEN_URI` Read the given URI by HTTP request
* `Reader.OPEN_LOCAL` Read the given path locally, works only in NodeJS

The default is `Reader.OPEN_URI`.

Methods
===

* `open(file, callback)` Open the specified file and call the callback on completion/ready
* `close()` Close the handle and clean up
* `read(length, position, callback)` Read `length` bytes from offset `position` and call `callback` with the resulting ArrayBuffer. If `position` is a function, it will be assumed to be the callback.

Notes
===

* You should call `Reader.close()` when finished with the instance to avoid leftover handles (primarily in Node)

License
===

MIT

---
_Source: https://npm.io/package/readerjs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._