# @writetome51/file-reader-service

> Abstract TypeScript/JavaScript class that simplifies javascript's built-in FileReader class. Has a getContents() method that begins the reading of a file and returns the result

Latest version **1.0.0** (published 2020-08-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install @writetome51/file-reader-service
pnpm add @writetome51/file-reader-service
yarn add @writetome51/file-reader-service
bun add @writetome51/file-reader-service
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2020-08-06 |
| First published | 2020-03-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Steve Thompson |
| Maintainers | writetome51 |
| Keywords | abstract, class, blob, file, reader, read |

## Links

- npm: https://www.npmjs.com/package/@writetome51/file-reader-service
- Repository: https://github.com/writetome51/file-reader-service
- Homepage: https://github.com/writetome51/file-reader-service#readme
- Issues: https://github.com/writetome51/file-reader-service/issues
- npm.io page: https://npm.io/package/@writetome51/file-reader-service

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 1.0.0 (latest) — 2020-08-06
- 0.0.1 — 2020-03-10

## README

# FileReaderService

Abstract TypeScript/JavaScript class that simplifies using [FileReader](https://developer.mozilla.org/en-US/docs/Web/API/FileReader).  
Make subclasses that read a file as text, data url, array buffer, or binary string.

## Examples
```ts
export class TextFileReaderService extends FileReaderService {

    constructor(){
        super('readAsText');
    }

}

export class DataURLFileReaderService extends FileReaderService {

    constructor(){
        super('readAsDataURL');
    }

}
```

## Constructor
```ts
constructor(
    __readMethod: 'readAsText' | 'readAsDataURL' | 'readAsArrayBuffer' | 'readAsBinaryString'
) 
```

## Properties
```ts
isReading: boolean // read-only
```

## Methods
```ts
async getContents(file: Blob): Promise<any>
```


## Installation

`npm i @writetome51/file-reader-service`

## Loading
```js
import { FileReaderService } from '@writetome51/file-reader-service';
```

## License
[MIT](https://choosealicense.com/licenses/mit/)

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