Installations

npm install @tanker/file-reader

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS, UMD

Node Version

18.18.0

NPM Version

10.2.4 Pull Requests

Open

0

Total

27

Closed

26

Merged

1

Issues

Open

0

Total

0

Closed

0

Releases

82

4.3.0

v4.3.0

Updated on Jan 06, 2025

v4.2.0

Updated on Jun 20, 2024

v4.1.1

Updated on Jan 15, 2024

v4.1.0

Updated on Jan 09, 2024

v4.0.0

Updated on Sep 20, 2023

v3.3.2

Updated on May 25, 2023

View All 82 releases

Languages

4

TypeScript

JavaScript

Python

Shell

TypeScript (98.22%)

JavaScript (1.1%)

Python (0.67%)

Shell (0.02%)

Developer

TankerHQ

Download Statistics

Total Downloads

0

Last Day

0

Last Week

0

Last Month

0

Last Year

0

GitHub Statistics

NOASSERTION License

800 Stars

2,746 Commits

26 Forks

11 Watchers

4 Branches

14 Contributors

Updated on Jun 29, 2025

Maintainers

4

View All 14 Contributors

Package Meta Information

Latest Version

4.3.0

Package Id

@tanker/file-reader@4.3.0

Unpacked Size

21.79 kB

Size

4.07 kB

File Count

19

NPM Version

10.2.4

Node Version

18.18.0

Published on

Jan 06, 2025

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

0%

NaN

Compared to previous day

Last Week

0%

NaN

Compared to previous week

Last Month

0%

NaN

Compared to previous month

Last Year

0%

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

2

@tanker/global-this tslib

Dev Dependencies

1

@tanker/test-utils

A promisified FileReader for browsers

Minified Size

A promisified FileReader implementation very similar to the browser's FileReader API, with a few differences:

the File or Blob instance is given at construction time;
all readAs... methods don't take a Blob or File instance as first argument anymore;
all readAs... methods return a Promise that can be awaited;
reading in chunks is easy as:
- you just need to await the next chunk (no event / callback API anymore);
- the current reading position is automatically tracked.

Usage

1import { FileReader } from '@tanker/file-reader';
2
3// Retrieve a file or blob somehow
4const file = new File(
5  ['The quick brown fox jumps over the lazy dog'],
6  'fox.txt',
7  { type: 'plain/text' }
8);
9
10// Create your file reader
11const reader = new FileReader(file);
12
13// Read the whole file
14const text = await reader.readAsText('UTF-8');
15const dataUrl = await reader.readAsDataURL();
16const arrayBuffer = await reader.readAsArrayBuffer();
17
18// Or read binary chunks (ArrayBuffer)
19const chunkSize = 8; // bytes
20let chunk;
21do {
22  chunk = await reader.readAsArrayBuffer(chunkSize);
23  // do something with the chunk
24} while (chunk.byteLength > 0);

About Tanker

This package is a dependency of the Tanker client SDKs for end-to-end encryption:

@tanker/client-browser for Web applications
@tanker/client-node for Node.js client applications

Read the documentation to get started.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

9

License

Determines if the project has defined a license.

6

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

SAST

Determines if the project uses static code analysis.

0

Security-Policy

Determines if the project has published a security policy.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Fuzzing

Determines if the project uses fuzzing.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

3.3

/10

Last Scanned on 2025-07-14

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More