rxjs-file

RxJS File

A small package with a couple of File utils for RxJS.

Table of Contents

• Installation
• Usage
• Contribute

Installation

You can install this package from NPM:

npm add rxjs rxjs-file

Or with Yarn:

yarn add rxjs rxjs-file

CDN

For CDN, you can use unpkg:

https://unpkg.com/rxjs-file/dist/bundles/rxjs-file.umd.min.js

The global namespace for rxjs-file is rxjsFile:

const {toArrayBuffer} = rxjsFile;

toArrayBuffer(file)
    .subscribe(buffer => {
        // Do something with the buffer 
    });

Usage

ES6

Read a file as ArrayBuffer:

import {toArrayBuffer} from 'rxjs-file';

toArrayBuffer(file)
    .subscribe(buffer => {
        // Do something with the buffer 
    });

Read the file as ArrayBuffer in chunks:

import {toArrayBuffer} from 'rxjs-file';

toArrayBuffer(file, {chunkSize: 1000 /* bytes */})
    .subscribe(chunk => {
        // Do something with each chunk
    });

Read a file as text:

import {toString} from 'rxjs-file';

toString(file)
    .subscribe(str => {
        // Do something with the string
    });

CommonJS

Read a file as ArrayBuffer:

const {toArrayBuffer} = require('rxjs-file');

toArrayBuffer(file)
    .subscribe(buffer => {
        // Do something with the buffer 
    });

Contribute

If you wish to contribute, please use the following guidelines:

• Use Conventional Commits
• Use [ci skip] in commit messages to skip a build