get-buffer
TypeScript icon, indicating that this package has built-in type declarations

1.6.0 • Public • Published

get-buffer

Build Status JavaScript Style Guide

Install

§ npm install get-buffer

Usage

const getBuffer = require('get-buffer');
const fs = require('fs');
const stream = fs.createReadStream('./test.png');

getBuffer.fromStream(stream, 4100)
.then(buffer => console.log(buffer))
.catch(err => console.error(err))

try{
    const buffer = getBuffer.fromPath('./test.png', 4100);
    console.log(buffer)
}catch(err){
    console.error(err);
}

API

fromStream(stream: Readable, callback: function)
fromStream(stream: Readable, bufferSize: int, callback: function)

Reads a Buffer from a Readable, bufferSize could be provided to limit the Buffer into a maximum size. Returns either a Promise or a function(callback).

fromPath(filePath: string)
fromPath(filePath: string, bufferSize: int)

Reads a Buffer from a path, bufferSize could be provided to limit the Buffer into a maximum size. Returns synchronously.

fromArrayBuffer(arrayBuffer: ArrayBuffer)
fromArrayBuffer(arrayBuffer: ArrayBuffer, bufferSize: int)

Reads a Buffer from a ArrayBuffer, bufferSize could be provided to limit the Buffer into a maximum size. Returns synchronously.

Package Sidebar

Install

npm i get-buffer

Weekly Downloads

82

Version

1.6.0

License

MIT

Unpacked Size

9.35 kB

Total Files

5

Last publish

Collaborators

  • emilsivervik