https://github.com/LinusU/buffer-from

A ponyfill for Buffer.from
https://github.com/LinusU/buffer-from

Last synced: about 2 months ago
JSON representation

A ponyfill for Buffer.from

• Host: GitHub
• URL: https://github.com/LinusU/buffer-from
• Owner: LinusU
• License: mit
• Created: 2016-08-18T19:44:34.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2021-07-29T17:05:31.000Z (over 3 years ago)
• Last Synced: 2024-11-13T20:41:06.648Z (about 2 months ago)
• Language: JavaScript
• Size: 43.9 KB
• Stars: 23
• Watchers: 4
• Forks: 10
• Open Issues: 3
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-ponyfills - buffer-from - [`Buffer.from`](https://nodejs.org/api/buffer.html#buffer_class_method_buffer_from_array) (Node.js Features)

README

        
# Buffer From

A [ponyfill](https://ponyfill.com) for `Buffer.from`, uses native implementation if available.

## Installation

```sh

npm install --save buffer-from

```

## Usage

```js

const bufferFrom = require('buffer-from')

console.log(bufferFrom([1, 2, 3, 4]))

//=> 

const arr = new Uint8Array([1, 2, 3, 4])

console.log(bufferFrom(arr.buffer, 1, 2))

//=> 

console.log(bufferFrom('test', 'utf8'))

//=> 

const buf = bufferFrom('test')

console.log(bufferFrom(buf))

//=> 

```

## 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](https://github.com/LinusU/buffer-alloc) A ponyfill for `Buffer.alloc`

- [buffer-alloc-unsafe](https://github.com/LinusU/buffer-alloc-unsafe) A ponyfill for `Buffer.allocUnsafe`