@stdlib/buffer-from-arraybuffer

Allocate a buffer from an ArrayBuffer.

https://github.com/stdlib-js/buffer-from-arraybuffer

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (15.6%) to scientific vocabulary

Keywords

allocate array arraybuffer binary buf buffer data javascript node node-js nodejs octet octets stdlib structure typed typed-array types

Last synced: 6 months ago · JSON representation

Repository

Allocate a buffer from an ArrayBuffer.

Basic Info

Host: GitHub
Owner: stdlib-js
License: apache-2.0
Language: JavaScript
Default Branch: main
Homepage: https://github.com/stdlib-js/stdlib
Size: 1.34 MB

Statistics

Stars: 1
Watchers: 3
Forks: 0
Open Issues: 0
Releases: 0

Topics

allocate array arraybuffer binary buf buffer data javascript node node-js nodejs octet octets stdlib structure typed typed-array types

Created over 4 years ago · Last pushed 9 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Security

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

arraybuffer2buffer

Allocate a buffer from an ArrayBuffer.

## Installation ```bash npm install @stdlib/buffer-from-arraybuffer ``` Alternatively, - To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]). - If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions). - For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]). The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships. To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

## Usage ```javascript var arraybuffer2buffer = require( '@stdlib/buffer-from-arraybuffer' ); ``` #### arraybuffer2buffer( buf\[, byteOffset\[, length]] ) Allocates a [buffer][@stdlib/buffer/ctor] from an [`ArrayBuffer`][@stdlib/array/buffer]. ```javascript var ArrayBuffer = require( '@stdlib/array-buffer' ); var ab = new ArrayBuffer( 10 ); var buf = arraybuffer2buffer( ab ); // returns ``` By default, the function allocates a [buffer][@stdlib/buffer/ctor] starting from the first byte of the provided [`ArrayBuffer`][@stdlib/array/buffer]. To specify an alternative starting index, provide a `byteOffset`. ```javascript var ArrayBuffer = require( '@stdlib/array-buffer' ); var ab = new ArrayBuffer( 10 ); var buf = arraybuffer2buffer( ab, 2 ); // returns var len = buf.length; // returns 8 ``` By default, the function allocates a [buffer][@stdlib/buffer/ctor] until the end of the provided [`ArrayBuffer`][@stdlib/array/buffer]. To allocate a specified number of [`ArrayBuffer`][@stdlib/array/buffer] bytes, provide a `length`. ```javascript var ArrayBuffer = require( '@stdlib/array-buffer' ); var ab = new ArrayBuffer( 10 ); var buf = arraybuffer2buffer( ab, 2, 4 ); // returns var len = buf.length; // returns 4 ```

## Notes The behavior of this function varies across Node.js versions due to changes in the underlying Node.js APIs: - `<3.0.0`: the function copies [`ArrayBuffer`][@stdlib/array/buffer] bytes to a new [`Buffer`][@stdlib/buffer/ctor] instance. - `>=3.0.0` and `<5.10.0`: if provided a `byteOffset`, the function copies [`ArrayBuffer`][@stdlib/array/buffer] bytes to a new [`Buffer`][@stdlib/buffer/ctor] instance; otherwise, the function returns a view of an [`ArrayBuffer`][@stdlib/array/buffer] without copying the underlying memory. - `<6.0.0`: if provided an empty [`ArrayBuffer`][@stdlib/array/buffer], the function returns an empty [`Buffer`][@stdlib/buffer/ctor] which is **not** an [`ArrayBuffer`][@stdlib/array/buffer] view. - `>=6.0.0`: the function returns a view of an [`ArrayBuffer`][@stdlib/array/buffer] without copying the underlying memory.

## Examples ```javascript var ArrayBuffer = require( '@stdlib/array-buffer' ); var Float64Array = require( '@stdlib/array-float64' ); var randu = require( '@stdlib/random-base-randu' ); var IS_LITTLE_ENDIAN = require( '@stdlib/assert-is-little-endian' ); var arraybuffer2buffer = require( '@stdlib/buffer-from-arraybuffer' ); var high; var view; var low; var buf; var ab; var i; // Allocate an ArrayBuffer: ab = new ArrayBuffer( 64 ); // Create a Float64 view and set random values: view = new Float64Array( ab ); for ( i = 0; i < view.length; i++ ) { view[ i ] = randu(); } // Create a new buffer from the ArrayBuffer: buf = arraybuffer2buffer( ab ); // Read the high and low words for each double: for ( i = 0; i < view.length; i++ ) { if ( IS_LITTLE_ENDIAN ) { high = buf.readUInt32LE( (8*i)+4 ); low = buf.readUInt32LE( 8*i ); } else { high = buf.readUInt32BE( 8*i ); low = buf.readUInt32BE( (8*i)+4 ); } console.log( 'Value: %d. High: %d. Low: %d.', view[ i ], high, low ); } ```

* * * ## Notice This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. #### Community [![Chat][chat-image]][chat-url] --- ## License See [LICENSE][stdlib-license]. ## Copyright Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].

Owner

Name: stdlib
Login: stdlib-js
Kind: organization

Website: https://stdlib.io
Twitter: stdlibjs
Repositories: 3,692
Profile: https://github.com/stdlib-js

Standard library for JavaScript.

GitHub Events

Total

Push event: 26

Last Year

Push event: 26

Committers

Last synced: about 2 years ago

All Time

Total Commits: 49
Total Committers: 1
Avg Commits per committer: 49.0
Development Distribution Score (DDS): 0.0

Past Year

Commits: 18
Committers: 1
Avg Commits per committer: 18.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
stdlib-bot	n**y@s**o	49

Committer Domains (Top 20 + Academic)

stdlib.io: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 0
Total pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Total issue authors: 0
Total pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- npm 28 last-month

Total dependent packages: 3
Total dependent repositories: 2
Total versions: 10
Total maintainers: 4

npmjs.org: @stdlib/buffer-from-arraybuffer

Allocate a buffer from an ArrayBuffer.

Homepage: https://stdlib.io
License: Apache-2.0
Latest release: 0.2.2
published over 1 year ago

Versions: 10
Dependent Packages: 3
Dependent Repositories: 2
Downloads: 28 Last month

Rankings

Dependent packages count: 5.9%

Dependent repos count: 7.6%

Average: 11.9%

Downloads: 13.7%

Forks count: 15.4%

Stargazers count: 16.7%

Maintainers (4)

planeshifter rreusser stdlib-bot kgryte

Funding

type: opencollective
url: https://opencollective.com/stdlib

Last synced: 6 months ago

Dependencies

package.json npm

@stdlib/array-buffer ^0.0.x development
@stdlib/array-float64 ^0.0.x development
@stdlib/assert-has-arraybuffer-support ^0.0.x development
@stdlib/assert-is-buffer ^0.0.x development
@stdlib/assert-is-little-endian ^0.0.x development
@stdlib/bench ^0.0.x development
@stdlib/math-base-special-pow ^0.0.x development
@stdlib/random-base-randu ^0.0.x development
istanbul ^0.4.1 development
proxyquire ^2.0.0 development
tap-spec 5.x.x development
tape git+https://github.com/kgryte/tape.git#fix/globby development
@stdlib/array-uint8 ^0.0.x
@stdlib/assert-is-arraybuffer ^0.0.x
@stdlib/assert-is-function ^0.0.x
@stdlib/assert-is-nonnegative-integer ^0.0.x
@stdlib/buffer-ctor ^0.0.x
@stdlib/buffer-from-array ^0.0.x
@stdlib/process-node-version ^0.0.x
@stdlib/string-format ^0.0.x

.github/workflows/benchmark.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/cancel.yml actions

styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/close_pull_requests.yml actions

superbrothers/close-pull-request v3 composite

.github/workflows/examples.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/npm_downloads.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite
actions/upload-artifact v3 composite
distributhor/workflow-webhook v3 composite

.github/workflows/productionize.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
stdlib-js/bundle-action main composite
stdlib-js/transform-errors-action main composite

.github/workflows/publish.yml actions

JS-DevTools/npm-publish v1 composite
act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/test.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/test_bundles.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
denoland/setup-deno v1 composite

.github/workflows/test_coverage.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
codecov/codecov-action v3 composite
distributhor/workflow-webhook v3 composite

.github/workflows/test_install.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite

@stdlib/buffer-from-arraybuffer

Science Score: 26.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

arraybuffer2buffer

Owner

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

npmjs.org: @stdlib/buffer-from-arraybuffer

Rankings

Maintainers (4)

Funding

Dependencies