JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 443
  • Score
    100M100P100Q95021F
  • License MIT

Package for getting Buffers from Streams and Files with maximum size input.

Package Exports

  • get-buffer
  • get-buffer/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (get-buffer) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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.