linusu / buffer-from

A ponyfill for Buffer.from

Buffer From

A ponyfill for Buffer.from, uses native implementation if available.

Installation

npm install --save buffer-from

Usage

const bufferFrom = require('buffer-from')

console.log(bufferFrom([1, 2, 3, 4]))
//=> <Buffer 01 02 03 04>

const arr = new Uint8Array([1, 2, 3, 4])
console.log(bufferFrom(arr.buffer, 1, 2))
//=> <Buffer 02 03>

console.log(bufferFrom('test', 'utf8'))
//=> <Buffer 74 65 73 74>

const buf = bufferFrom('test')
console.log(bufferFrom(buf))
//=> <Buffer 74 65 73 74>

API

bufferFrom(array)

• array <Array>

Allocates a new Buffer using an array of octets.

bufferFrom(arrayBuffer[, byteOffset[, length]])

• arrayBuffer <ArrayBuffer> The .buffer property of a TypedArray or ArrayBuffer
• byteOffset <Integer> Where to start copying from arrayBuffer. Default: 0
• length <Integer> How many bytes to copy from arrayBuffer. Default: arrayBuffer.length - byteOffset

When passed a reference to the .buffer property of a TypedArray instance, the newly created Buffer will share the same allocated memory as the TypedArray.

The optional byteOffset and length arguments specify a memory range within the arrayBuffer that will be shared by the Buffer.

bufferFrom(buffer)

• buffer <Buffer> An existing Buffer to copy data from

Copies the passed buffer data onto a new Buffer instance.

bufferFrom(string[, encoding])

• string <String> A string to encode.
• encoding <String> The encoding of string. Default: 'utf8'

Creates a new Buffer containing the given JavaScript string string. If provided, the encoding parameter identifies the character encoding of string.

See also

• buffer-alloc A ponyfill for Buffer.alloc
• buffer-alloc-unsafe A ponyfill for Buffer.allocUnsafe

buffer-from's Issues

Getting error "TypeError: this is not a typed array."

When I try to use the module (buffer from string), I get the following error: TypeError: this is not a typed array.

Using Node v4.3.2.

Is it time to depricate the npm package?

just asking... it have been available since v5.10

Can't find variable: Buffer

An error occurs when attempting to run a react-native project.

It is originating from index.js, line 4.

For whatever reason, it seems like Buffer is not available in the global scope.

I was able to resolve this by adding the following before var isModern = (

if (typeof Buffer === 'undefined') {
  global.Buffer = require('buffer').Buffer
}

Afterwards my project runs correctly.

Get error "TypeError: utf8 is not a function"

Triggering condition:
When Buffer.alloc and the Buffer.allocUnsafe function are polyfilled by other modules, and the version of node is less than v4.5.0.

Cause:
The Buffer.from method isn't realized until v4.5.0, but it is a function befor v4.5.0.

I think you maybe already know this and use two methods ,Buffer.alloc and Buffer.allocUnsafe, also added in v4.5.0 as auxiliary conditions to judge if the environment is modern.
Is it better to judge the version of node or try the from method to judge if it is really usable?

LICENSE file is not part of published npm module

Sorry for annoying you with the LICENSE topic again

installing [email protected]
npm install [email protected]

and checking the retrieved files
ls node_modules/buffer-from

turns out, that the LICENSE file is not part of the distributed module.
Only these files are present:
index.js package.json readme.md

I think it would be a good thing to include the LICENSE file with the distributed module

Buffer is undefined in some environments

@LinusU Hi! I've found this package because it's used in html-tokenize, which is used in @emotion/server. This last package is related to server side rendering stuff and I'm trying to make it work in non-Node.js envrionments, such as Cloudflare Workers.

My problem is that this library (buffer-from) tries to access Buffer on import. Therefore, even if the rest of the functions are never called (they are not in this scenario), the app crashes due to having Buffer undefined.

Would you consider adding typeof Buffer !== 'undefined' && in the logic for isModern?
Thanks!