{"id":19472025,"url":"https://github.com/stdlib-js/array-shared-buffer","last_synced_at":"2025-04-25T12:31:14.984Z","repository":{"id":41358284,"uuid":"377219767","full_name":"stdlib-js/array-shared-buffer","owner":"stdlib-js","description":"SharedArrayBuffer.","archived":false,"fork":false,"pushed_at":"2025-03-03T00:36:23.000Z","size":488,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-20T16:04:12.730Z","etag":null,"topics":["array","arraybuffer","buf","buffer","concurrency","data","javascript","memory","node","node-js","nodejs","parallelism","shared","stdlib","structure","threading","typed","typed-array","types"],"latest_commit_sha":null,"homepage":"https://github.com/stdlib-js/stdlib","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stdlib-js.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["stdlib-js"],"open_collective":"stdlib","tidelift":"npm/@stdlib/stdlib"}},"created_at":"2021-06-15T16:00:44.000Z","updated_at":"2025-03-03T00:32:23.000Z","dependencies_parsed_at":"2023-02-17T06:31:15.491Z","dependency_job_id":"97dfb105-ec51-4a93-9da3-0df2db24cb9d","html_url":"https://github.com/stdlib-js/array-shared-buffer","commit_stats":{"total_commits":51,"total_committers":1,"mean_commits":51.0,"dds":0.0,"last_synced_commit":"67efacb5b55df7d48c8c69f0dbfa47422552673b"},"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Farray-shared-buffer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Farray-shared-buffer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Farray-shared-buffer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Farray-shared-buffer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stdlib-js","download_url":"https://codeload.github.com/stdlib-js/array-shared-buffer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250817591,"owners_count":21492178,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["array","arraybuffer","buf","buffer","concurrency","data","javascript","memory","node","node-js","nodejs","parallelism","shared","stdlib","structure","threading","typed","typed-array","types"],"created_at":"2024-11-10T19:11:52.001Z","updated_at":"2025-04-25T12:31:14.948Z","avatar_url":"https://github.com/stdlib-js.png","language":"JavaScript","readme":"\u003c!--\n\n@license Apache-2.0\n\nCopyright (c) 2018 The Stdlib Authors.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n--\u003e\n\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    About stdlib...\n  \u003c/summary\u003e\n  \u003cp\u003eWe 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.\u003c/p\u003e\n  \u003cp\u003eThe 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.\u003c/p\u003e\n  \u003cp\u003eWhen 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.\u003c/p\u003e\n  \u003cp\u003eTo join us in bringing numerical computing to the web, get started by checking us out on \u003ca href=\"https://github.com/stdlib-js/stdlib\"\u003eGitHub\u003c/a\u003e, and please consider \u003ca href=\"https://opencollective.com/stdlib\"\u003efinancially supporting stdlib\u003c/a\u003e. We greatly appreciate your continued support!\u003c/p\u003e\n\u003c/details\u003e\n\n# SharedArrayBuffer\n\n[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] \u003c!-- [![dependencies][dependencies-image]][dependencies-url] --\u003e\n\n\u003e [Constructor][mdn-sharedarraybuffer] returning an object used to represent a generic, fixed-length raw binary data buffer which can be used to create views of shared memory.\n\n\u003c!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"intro\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.intro --\u003e\n\n\u003c!-- Package usage documentation. --\u003e\n\n\u003csection class=\"installation\"\u003e\n\n## Installation\n\n```bash\nnpm install @stdlib/array-shared-buffer\n```\n\nAlternatively,\n\n-   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]).\n-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).\n-   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]).\n\nThe [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.\n\nTo 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.\n\n\u003c/section\u003e\n\n\u003csection class=\"usage\"\u003e\n\n## Usage\n\n```javascript\nvar SharedArrayBuffer = require( '@stdlib/array-shared-buffer' );\n```\n\n#### SharedArrayBuffer( size )\n\nReturns a [`SharedArrayBuffer`][mdn-sharedarraybuffer] having a specified number of bytes.\n\n\u003c!-- eslint-disable stdlib/require-globals, no-unused-vars, no-inner-declarations --\u003e\n\n```javascript\ntry {\n    var buf = new SharedArrayBuffer( 5 );\n    // returns \u003cSharedArrayBuffer\u003e\n} catch ( err ) {\n    console.log( 'Environment does not support SharedArrayBuffers.' );\n}\n```\n\n* * *\n\n### Properties\n\n#### SharedArrayBuffer.length\n\nNumber of input arguments the constructor accepts.\n\n\u003c!-- eslint-disable stdlib/require-globals --\u003e\n\n```javascript\nvar len = SharedArrayBuffer.length;\n// returns 1\n```\n\n#### SharedArrayBuffer.prototype.byteLength\n\n**Read-only** property which returns the length (in bytes) of the [`SharedArrayBuffer`][mdn-sharedarraybuffer].\n\n\u003c!-- eslint-disable stdlib/require-globals, no-unused-vars, no-inner-declarations --\u003e\n\n```javascript\ntry {\n    var buf = new SharedArrayBuffer( 5 );\n    var byteLength = buf.byteLength;\n    // returns 5\n} catch ( err ) {\n    console.log( 'Environment does not support SharedArrayBuffers.' );\n}\n```\n\n* * *\n\n### Methods\n\n#### SharedArrayBuffer.prototype.slice( \\[start\\[, end]] )\n\nCopies the bytes of a [`SharedArrayBuffer`][mdn-sharedarraybuffer] to a new [`SharedArrayBuffer`][mdn-sharedarraybuffer].\n\n\u003c!-- eslint-disable stdlib/require-globals, no-unused-vars, no-inner-declarations --\u003e\n\n```javascript\ntry {\n    var b1 = new SharedArrayBuffer( 10 );\n\n    var b2 = b1.slice();\n    // returns \u003cSharedArrayBuffer\u003e\n\n    var bool = ( b2 === b1 );\n    // returns false\n} catch ( err ) {\n    console.log( 'Environment does not support SharedArrayBuffers.' );\n}\n```\n\nBy default, the method copies from the beginning of the [`SharedArrayBuffer`][mdn-sharedarraybuffer]. To beginning copying from a different byte index, provide a `start` argument, specifying the starting byte index (inclusive).\n\n\u003c!-- eslint-disable stdlib/require-globals, no-unused-vars, no-inner-declarations --\u003e\n\n```javascript\ntry {\n    var b1 = new SharedArrayBuffer( 10 );\n    var b2 = b1.slice( 2 );\n\n    var nbytes = b2.byteLength;\n    // returns 8\n} catch ( err ) {\n    console.log( 'Environment does not support SharedArrayBuffers.' );\n}\n```\n\nIf `start \u003c 0`, the index is relative to the end of the [`SharedArrayBuffer`][mdn-sharedarraybuffer].\n\n\u003c!-- eslint-disable stdlib/require-globals, no-unused-vars, no-inner-declarations --\u003e\n\n```javascript\ntry {\n    var b1 = new SharedArrayBuffer( 10 );\n    var b2 = b1.slice( -2 );\n\n    var nbytes = b2.byteLength;\n    // returns 2\n} catch ( err ) {\n    console.log( 'Environment does not support SharedArrayBuffers.' );\n}\n```\n\nBy default, the method copies to the end of the [`SharedArrayBuffer`][mdn-sharedarraybuffer]. To copy until a particular byte index, provide an `end` index, specifying the ending byte index (exclusive).\n\n\u003c!-- eslint-disable stdlib/require-globals, no-unused-vars, no-inner-declarations --\u003e\n\n```javascript\ntry {\n    var b1 = new SharedArrayBuffer( 10 );\n    var b2 = b1.slice( 2, 6 );\n\n    var nbytes = b2.byteLength;\n    // returns 4\n} catch ( err ) {\n    console.log( 'Environment does not support SharedArrayBuffers.' );\n}\n```\n\nIf `end \u003c 0`, the index is relative to the end of the [`SharedArrayBuffer`][mdn-sharedarraybuffer].\n\n\u003c!-- eslint-disable stdlib/require-globals, no-unused-vars, no-inner-declarations --\u003e\n\n```javascript\ntry {\n    var b1 = new SharedArrayBuffer( 10 );\n    var b2 = b1.slice( 2, -2 );\n\n    var nbytes = b2.byteLength;\n    // returns 6\n} catch ( err ) {\n    console.log( 'Environment does not support SharedArrayBuffers.' );\n}\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\n\n* * *\n\n\u003c!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"notes\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.notes --\u003e\n\n\u003c!-- Package usage examples. --\u003e\n\n\u003csection class=\"examples\"\u003e\n\n## Examples\n\n\u003c!-- TODO: update example to show explicit threading use case --\u003e\n\n\u003c!-- eslint no-undef: \"error\" --\u003e\n\n\u003c!-- eslint-disable no-unused-vars --\u003e\n\n```javascript\nvar randu = require( '@stdlib/random-base-randu' );\nvar Float64Array = require( '@stdlib/array-float64' );\nvar Uint8Array = require( '@stdlib/array-uint8' );\nvar toBinaryString = require( '@stdlib/number-uint8-base-to-binary-string' );\nvar SharedArrayBuffer = require( '@stdlib/array-shared-buffer' );\n\nfunction main() {\n    var bytes;\n    var buf;\n    var arr;\n    var i;\n\n    // Create a new SharedArrayBuffer:\n    buf = new SharedArrayBuffer( 64 );\n\n    // Create a Float64 array buffer view:\n    arr = new Float64Array( buf.byteLength/8 );\n    for ( i = 0; i \u003c arr.length; i++ ) {\n        arr[ i ] = randu() * 100.0;\n    }\n\n    // Create a \"bytes\" view of the array buffer:\n    bytes = new Uint8Array( arr.buffer );\n\n    // Print the bytes:\n    for ( i = 0; i \u003c bytes.length; i++ ) {\n        console.log( 'byte %d: %s', i, toBinaryString( bytes[ i ] ) );\n    }\n}\n\ntry {\n    main();\n} catch ( err ) {\n    console.error( 'Environment does not provide SharedArrayBuffer support.' );\n}\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.examples --\u003e\n\n\u003c!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"references\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.references --\u003e\n\n\u003c!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --\u003e\n\n\u003csection class=\"related\"\u003e\n\n* * *\n\n## See Also\n\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/buffer-ctor`][@stdlib/buffer/ctor]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003eBuffer.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/array-buffer`][@stdlib/array/buffer]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003eArrayBuffer.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/array-float32`][@stdlib/array/float32]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003eFloat32Array.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/array-float64`][@stdlib/array/float64]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003eFloat64Array.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/array-int16`][@stdlib/array/int16]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003eInt16Array.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/array-int32`][@stdlib/array/int32]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003eInt32Array.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/array-int8`][@stdlib/array/int8]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003eInt8Array.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/array-uint16`][@stdlib/array/uint16]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003eUint16Array.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/array-uint32`][@stdlib/array/uint32]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003eUint32Array.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/array-uint8`][@stdlib/array/uint8]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003eUint8Array.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/array-uint8c`][@stdlib/array/uint8c]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003eUint8ClampedArray.\u003c/span\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.related --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\n\u003csection class=\"main-repo\" \u003e\n\n* * *\n\n## Notice\n\nThis 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.\n\nFor 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].\n\n#### Community\n\n[![Chat][chat-image]][chat-url]\n\n---\n\n## License\n\nSee [LICENSE][stdlib-license].\n\n\n## Copyright\n\nCopyright \u0026copy; 2016-2025. The Stdlib [Authors][stdlib-authors].\n\n\u003c/section\u003e\n\n\u003c!-- /.stdlib --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"links\"\u003e\n\n[npm-image]: http://img.shields.io/npm/v/@stdlib/array-shared-buffer.svg\n[npm-url]: https://npmjs.org/package/@stdlib/array-shared-buffer\n\n[test-image]: https://github.com/stdlib-js/array-shared-buffer/actions/workflows/test.yml/badge.svg?branch=main\n[test-url]: https://github.com/stdlib-js/array-shared-buffer/actions/workflows/test.yml?query=branch:main\n\n[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/array-shared-buffer/main.svg\n[coverage-url]: https://codecov.io/github/stdlib-js/array-shared-buffer?branch=main\n\n\u003c!--\n\n[dependencies-image]: https://img.shields.io/david/stdlib-js/array-shared-buffer.svg\n[dependencies-url]: https://david-dm.org/stdlib-js/array-shared-buffer/main\n\n--\u003e\n\n[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg\n[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im\n\n[stdlib]: https://github.com/stdlib-js/stdlib\n\n[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors\n\n[umd]: https://github.com/umdjs/umd\n[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules\n\n[deno-url]: https://github.com/stdlib-js/array-shared-buffer/tree/deno\n[deno-readme]: https://github.com/stdlib-js/array-shared-buffer/blob/deno/README.md\n[umd-url]: https://github.com/stdlib-js/array-shared-buffer/tree/umd\n[umd-readme]: https://github.com/stdlib-js/array-shared-buffer/blob/umd/README.md\n[esm-url]: https://github.com/stdlib-js/array-shared-buffer/tree/esm\n[esm-readme]: https://github.com/stdlib-js/array-shared-buffer/blob/esm/README.md\n[branches-url]: https://github.com/stdlib-js/array-shared-buffer/blob/main/branches.md\n\n[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-shared-buffer/main/LICENSE\n\n[mdn-sharedarraybuffer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer\n\n\u003c!-- \u003crelated-links\u003e --\u003e\n\n[@stdlib/buffer/ctor]: https://github.com/stdlib-js/buffer-ctor\n\n[@stdlib/array/buffer]: https://github.com/stdlib-js/array-buffer\n\n[@stdlib/array/float32]: https://github.com/stdlib-js/array-float32\n\n[@stdlib/array/float64]: https://github.com/stdlib-js/array-float64\n\n[@stdlib/array/int16]: https://github.com/stdlib-js/array-int16\n\n[@stdlib/array/int32]: https://github.com/stdlib-js/array-int32\n\n[@stdlib/array/int8]: https://github.com/stdlib-js/array-int8\n\n[@stdlib/array/uint16]: https://github.com/stdlib-js/array-uint16\n\n[@stdlib/array/uint32]: https://github.com/stdlib-js/array-uint32\n\n[@stdlib/array/uint8]: https://github.com/stdlib-js/array-uint8\n\n[@stdlib/array/uint8c]: https://github.com/stdlib-js/array-uint8c\n\n\u003c!-- \u003c/related-links\u003e --\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.links --\u003e\n","funding_links":["https://github.com/sponsors/stdlib-js","https://opencollective.com/stdlib","https://tidelift.com/funding/github/npm/@stdlib/stdlib"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Farray-shared-buffer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstdlib-js%2Farray-shared-buffer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Farray-shared-buffer/lists"}