@craftzdog/react-native-buffer v6.1.0

@craftzdog/react-native-buffer

The buffer module from node.js, for React Native.

Simply require('@craftzdog/react-native-buffer') or use the Buffer global and you will get this module. It internally uses react-native-quick-base64, which is a performant native implementation of base64.

The goal is to provide an API that is 100% identical to node's Buffer API. Read the official docs for the full list of properties, instance methods, and class methods that are supported.

features

• Manipulate binary data like a boss, in all browsers!
• Super fast. Backed by Typed Arrays (Uint8Array/ArrayBuffer, not Object)
• Extremely small bundle size (6.75KB minified + gzipped, 51.9KB with comments)
• Excellent browser support (Chrome, Firefox, Edge, Safari 11+, iOS 11+, Android, etc.)
• Preserves Node API exactly
• Square-bracket buf[4] notation works!
• Does not modify any browser prototypes or put anything on window
• Comprehensive test suite (including all buffer tests from node.js core)

install

npm install @craftzdog/react-native-buffer react-native-quick-base64
cd ios && pod install

usage

The module's API is identical to node's Buffer API. Read the official docs for the full list of properties, instance methods, and class methods that are supported.

To depend on this module explicitly, require it like this:

import { Buffer } from "@craftzdog/react-native-buffer";

how does it work?

The Buffer constructor returns instances of Uint8Array that have their prototype changed to Buffer.prototype. Furthermore, Buffer is a subclass of Uint8Array, so the returned instances will have all the node Buffer methods and the Uint8Array methods. Square bracket notation works as expected -- it returns a single octet.

The Uint8Array prototype remains unmodified.

conversion packages

convert typed array to buffer

Use typedarray-to-buffer to convert any kind of typed array to a Buffer. Does not perform a copy, so it's super fast.

convert buffer to typed array

Buffer is a subclass of Uint8Array (which is a typed array). So there is no need to explicitly convert to typed array. Just use the buffer as a Uint8Array.

convert blob to buffer

Use blob-to-buffer to convert a Blob to a Buffer.

convert buffer to blob

To convert a Buffer to a Blob, use the Blob constructor:

var blob = new Blob([buffer]);

Optionally, specify a mimetype:

var blob = new Blob([buffer], { type: "text/html" });

convert arraybuffer to buffer

To convert an ArrayBuffer to a Buffer, use the Buffer.from function. Does not perform a copy, so it's super fast.

var buffer = Buffer.from(arrayBuffer);

convert buffer to arraybuffer

To convert a Buffer to an ArrayBuffer, use the .buffer property (which is present on all Uint8Array objects):

var arrayBuffer = buffer.buffer.slice(
  buffer.byteOffset,
  buffer.byteOffset + buffer.byteLength
);

Alternatively, use the to-arraybuffer module.

performance

4x faster than base64-js on an iPhone 11 Pro when dealing with base64, thanks to react-native-quick-base64.

Testing the project

First, install the project:

npm install

Then, to run tests in Node.js, run:

npm run test-node

To test locally in a browser, you can run:

npm run test-browser-old-local # For ES5 browsers that don't support ES6
npm run test-browser-new-local # For ES6 compliant browsers

This will print out a URL that you can then open in a browser to run the tests, using airtap.

To run automated browser tests using Saucelabs, ensure that your SAUCE_USERNAME and SAUCE_ACCESS_KEY environment variables are set, then run:

npm test

This is what's run in Travis, to check against various browsers. The list of browsers is kept in the bin/airtap-es5.yml and bin/airtap-es6.yml files.

JavaScript Standard Style

This module uses JavaScript Standard Style.

To test that the code conforms to the style, npm install and run:

Credit

This was originally forked from feross/buffer.

Security Policies and Procedures

The buffer team and community take all security bugs in buffer seriously. Please see our security policies and procedures document to learn how to report issues.

license

MIT. Copyright (C) Takuya Matsuyama, and other contributors. Originally forked from an MIT-licensed module by Feross Aboukhadijeh and Romain Beauxis.