{"id":28970088,"url":"https://github.com/stdlib-js/array-struct-factory","last_synced_at":"2026-04-29T09:02:41.314Z","repository":{"id":300559276,"uuid":"1006075421","full_name":"stdlib-js/array-struct-factory","owner":"stdlib-js","description":"Return a constructor for creating arrays having a fixed-width composite data type.","archived":false,"fork":false,"pushed_at":"2026-04-09T03:57:33.000Z","size":730,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-09T05:28:35.417Z","etag":null,"topics":["array","composite","data","factory","javascript","node","node-js","nodejs","stdlib","struct","structure","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,"notice":"NOTICE","maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":["stdlib-js"],"open_collective":"stdlib","tidelift":"npm/@stdlib/stdlib"}},"created_at":"2025-06-21T12:42:46.000Z","updated_at":"2026-04-09T03:33:52.000Z","dependencies_parsed_at":"2025-06-22T12:18:35.105Z","dependency_job_id":"85996e98-c9b1-4e27-aca8-1fc03a31abd9","html_url":"https://github.com/stdlib-js/array-struct-factory","commit_stats":null,"previous_names":["stdlib-js/array-struct-factory"],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/stdlib-js/array-struct-factory","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Farray-struct-factory","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Farray-struct-factory/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Farray-struct-factory/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Farray-struct-factory/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stdlib-js","download_url":"https://codeload.github.com/stdlib-js/array-struct-factory/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Farray-struct-factory/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32418173,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-29T06:29:02.080Z","status":"ssl_error","status_checked_at":"2026-04-29T06:29:00.631Z","response_time":110,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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","composite","data","factory","javascript","node","node-js","nodejs","stdlib","struct","structure","typed","typed-array","types"],"created_at":"2025-06-24T10:19:53.884Z","updated_at":"2026-04-29T09:02:41.304Z","avatar_url":"https://github.com/stdlib-js.png","language":"JavaScript","funding_links":["https://github.com/sponsors/stdlib-js","https://opencollective.com/stdlib","https://tidelift.com/funding/github/npm/@stdlib/stdlib"],"categories":[],"sub_categories":[],"readme":"\u003c!--\n\n@license Apache-2.0\n\nCopyright (c) 2025 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# structFactory\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 Return a constructor for creating arrays having a fixed-width composite data type.\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-struct-factory\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 structFactory = require( '@stdlib/array-struct-factory' );\n```\n\n#### structFactory( arg )\n\nReturns a constructor for creating arrays having a fixed-width composite data type.\n\n```javascript\nvar schema = [\n    {\n        'name': 'beep',\n        'type': 'float64'\n    },\n    {\n        'name': 'boop',\n        'type': 'int32'\n    }\n];\nvar StructArray = structFactory( schema );\n// returns \u003cFunction\u003e\n```\n\nThe function supports the following parameters:\n\n-   **arg**: [`struct`][@stdlib/dstructs/struct] constructor or a [`struct`][@stdlib/dstructs/struct] schema.\n\n* * *\n\n### Array Constructor\n\n#### StructArray()\n\nTODO: add documentation of constructor\n\n* * *\n\n### Array Properties\n\n\u003ca name=\"static-prop-bytes-per-element\"\u003e\u003c/a\u003e\n\n#### StructArray.BYTES_PER_ELEMENT\n\nNumber of bytes per view element.\n\n```javascript\nvar schema = [\n    {\n        'name': 'foo',\n        'type': 'bool'\n    }\n];\nvar StructArray = structFactory( schema );\n\nvar nbytes = StructArray.BYTES_PER_ELEMENT;\n// returns 1\n```\n\n\u003ca name=\"static-prop-name\"\u003e\u003c/a\u003e\n\n#### StructArray.name\n\nArray constructor name.\n\n```javascript\nvar schema = [\n    {\n        'name': 'foo',\n        'type': 'bool'\n    }\n];\nvar StructArray = structFactory( schema );\n\nvar str = StructArray.name;\n// returns 'StructArray'\n```\n\n\u003ca name=\"prop-buffer\"\u003e\u003c/a\u003e\n\n#### StructArray.prototype.buffer\n\n**Read-only** property which returns the [`ArrayBuffer`][@stdlib/array/buffer] referenced by the array.\n\n```javascript\nvar schema = [\n    {\n        'name': 'foo',\n        'type': 'bool'\n    }\n];\nvar StructArray = structFactory( schema );\n\nvar arr = new StructArray( 5 );\nvar buf = arr.buffer;\n// returns \u003cArrayBuffer\u003e\n```\n\n\u003ca name=\"prop-byte-length\"\u003e\u003c/a\u003e\n\n#### StructArray.prototype.byteLength\n\n**Read-only** property which returns the length (in bytes) of the array.\n\n```javascript\nvar schema = [\n    {\n        'name': 'foo',\n        'type': 'int32'\n    }\n];\nvar StructArray = structFactory( schema );\n\nvar arr = new StructArray( 5 );\nvar byteLength = arr.byteLength;\n// returns 20\n```\n\n\u003ca name=\"prop-byte-offset\"\u003e\u003c/a\u003e\n\n#### StructArray.prototype.byteOffset\n\n**Read-only** property which returns the offset (in bytes) of the array from the start of its [`ArrayBuffer`][@stdlib/array/buffer].\n\n```javascript\nvar schema = [\n    {\n        'name': 'foo',\n        'type': 'bool'\n    }\n];\nvar StructArray = structFactory( schema );\n\nvar arr = new StructArray( 5 );\nvar byteOffset = arr.byteOffset;\n// returns 0\n```\n\n\u003ca name=\"prop-bytes-per-element\"\u003e\u003c/a\u003e\n\n#### StructArray.prototype.BYTES_PER_ELEMENT\n\nNumber of bytes per view element.\n\n```javascript\nvar schema = [\n    {\n        'name': 'foo',\n        'type': 'bool'\n    }\n];\nvar StructArray = structFactory( schema );\n\nvar arr = new StructArray( 5 );\nvar nbytes = arr.BYTES_PER_ELEMENT;\n// returns 1\n```\n\n\u003ca name=\"prop-length\"\u003e\u003c/a\u003e\n\n#### StructArray.prototype.length\n\n**Read-only** property which returns the number of view elements.\n\n```javascript\nvar schema = [\n    {\n        'name': 'foo',\n        'type': 'bool'\n    }\n];\nvar StructArray = structFactory( schema );\n\nvar arr = new StructArray( 5 );\nvar len = arr.length;\n// returns 5\n```\n\n* * *\n\n### Array Methods\n\nTODO: document methods\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\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* * *\n\n## Notes\n\n-   While returned constructors _strive_ to maintain (but do not **guarantee**) consistency with [typed arrays][@stdlib/array/typed], significant deviations from ECMAScript-defined [typed array][@stdlib/array/typed] behavior are as follows:\n\n    -   Constructors do **not** require the `new` operator.\n    -   Accessing array elements using bracket syntax (e.g., `X[i]`) is **not** supported. Instead, one **must** use the `.get()` method.\n    -   Accessed array elements are a view on underlying memory. Thus, mutation of accessed elements mutates the underlying buffer.\n\n-   Struct arrays share several similarities with generic arrays containing objects (e.g., nested property access); however, the principal difference is that struct arrays are strongly typed and backed by fixed memory. Struct arrays are particularly well-suited for zero-copy transfer of data stored in composite data types when interoperating between JavaScript and C.\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!-- eslint no-undef: \"error\" --\u003e\n\n```javascript\nvar factory = require( '@stdlib/array-struct-factory' );\n\n// Define a schema for a composite data type for storing a student's test scores:\nvar schema = [\n    {\n        'name': 'test_number',\n        'type': 'int16'\n    },\n    {\n        'name': 'pass',\n        'type': 'bool'\n    },\n    {\n        'name': 'correct',\n        'type': 'int32'\n    },\n    {\n        'name': 'incorrect',\n        'type': 'int32'\n    },\n    {\n        'name': 'percentage',\n        'type': 'float32'\n    }\n];\n\n// Create an array constructor for creating composite data type arrays:\nvar TestScoreArray = factory( schema );\nconsole.log( 'Layout: %s', TestScoreArray.struct.layout );\n\n// Create a new array for storing test scores:\nvar student1 = new TestScoreArray( 10 );\nconsole.log( 'Byte length: %d', student1.byteLength );\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\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-2026. 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-struct-factory.svg\n[npm-url]: https://npmjs.org/package/@stdlib/array-struct-factory\n\n[test-image]: https://github.com/stdlib-js/array-struct-factory/actions/workflows/test.yml/badge.svg?branch=main\n[test-url]: https://github.com/stdlib-js/array-struct-factory/actions/workflows/test.yml?query=branch:main\n\n[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/array-struct-factory/main.svg\n[coverage-url]: https://codecov.io/github/stdlib-js/array-struct-factory?branch=main\n\n\u003c!--\n\n[dependencies-image]: https://img.shields.io/david/stdlib-js/array-struct-factory.svg\n[dependencies-url]: https://david-dm.org/stdlib-js/array-struct-factory/main\n\n--\u003e\n\n[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg\n[chat-url]: https://stdlib.zulipchat.com\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-struct-factory/tree/deno\n[deno-readme]: https://github.com/stdlib-js/array-struct-factory/blob/deno/README.md\n[umd-url]: https://github.com/stdlib-js/array-struct-factory/tree/umd\n[umd-readme]: https://github.com/stdlib-js/array-struct-factory/blob/umd/README.md\n[esm-url]: https://github.com/stdlib-js/array-struct-factory/tree/esm\n[esm-readme]: https://github.com/stdlib-js/array-struct-factory/blob/esm/README.md\n[branches-url]: https://github.com/stdlib-js/array-struct-factory/blob/main/branches.md\n\n[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-struct-factory/main/LICENSE\n\n[@stdlib/array/typed]: https://github.com/stdlib-js/array-typed\n\n[@stdlib/array/buffer]: https://github.com/stdlib-js/array-buffer\n\n[@stdlib/dstructs/struct]: https://github.com/stdlib-js/dstructs-struct\n\n\u003c/section\u003e\n\n\u003c!-- /.links --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Farray-struct-factory","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstdlib-js%2Farray-struct-factory","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Farray-struct-factory/lists"}