https://github.com/stdlib-js/array-struct-factory
Return a constructor for creating arrays having a fixed-width composite data type.
https://github.com/stdlib-js/array-struct-factory
array composite data factory javascript node node-js nodejs stdlib struct structure typed typed-array types
Last synced: 22 days ago
JSON representation
Return a constructor for creating arrays having a fixed-width composite data type.
- Host: GitHub
- URL: https://github.com/stdlib-js/array-struct-factory
- Owner: stdlib-js
- License: apache-2.0
- Created: 2025-06-21T12:42:46.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2026-04-09T03:57:33.000Z (about 1 month ago)
- Last Synced: 2026-04-09T05:28:35.417Z (about 1 month ago)
- Topics: array, composite, data, factory, javascript, node, node-js, nodejs, stdlib, struct, structure, typed, typed-array, types
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 713 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
- Notice: NOTICE
Awesome Lists containing this project
README
About stdlib...
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!
# structFactory
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Return a constructor for creating arrays having a fixed-width composite data type.
## Installation
```bash
npm install @stdlib/array-struct-factory
```
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 structFactory = require( '@stdlib/array-struct-factory' );
```
#### structFactory( arg )
Returns a constructor for creating arrays having a fixed-width composite data type.
```javascript
var schema = [
{
'name': 'beep',
'type': 'float64'
},
{
'name': 'boop',
'type': 'int32'
}
];
var StructArray = structFactory( schema );
// returns
```
The function supports the following parameters:
- **arg**: [`struct`][@stdlib/dstructs/struct] constructor or a [`struct`][@stdlib/dstructs/struct] schema.
* * *
### Array Constructor
#### StructArray()
TODO: add documentation of constructor
* * *
### Array Properties
#### StructArray.BYTES_PER_ELEMENT
Number of bytes per view element.
```javascript
var schema = [
{
'name': 'foo',
'type': 'bool'
}
];
var StructArray = structFactory( schema );
var nbytes = StructArray.BYTES_PER_ELEMENT;
// returns 1
```
#### StructArray.name
Array constructor name.
```javascript
var schema = [
{
'name': 'foo',
'type': 'bool'
}
];
var StructArray = structFactory( schema );
var str = StructArray.name;
// returns 'StructArray'
```
#### StructArray.prototype.buffer
**Read-only** property which returns the [`ArrayBuffer`][@stdlib/array/buffer] referenced by the array.
```javascript
var schema = [
{
'name': 'foo',
'type': 'bool'
}
];
var StructArray = structFactory( schema );
var arr = new StructArray( 5 );
var buf = arr.buffer;
// returns
```
#### StructArray.prototype.byteLength
**Read-only** property which returns the length (in bytes) of the array.
```javascript
var schema = [
{
'name': 'foo',
'type': 'int32'
}
];
var StructArray = structFactory( schema );
var arr = new StructArray( 5 );
var byteLength = arr.byteLength;
// returns 20
```
#### StructArray.prototype.byteOffset
**Read-only** property which returns the offset (in bytes) of the array from the start of its [`ArrayBuffer`][@stdlib/array/buffer].
```javascript
var schema = [
{
'name': 'foo',
'type': 'bool'
}
];
var StructArray = structFactory( schema );
var arr = new StructArray( 5 );
var byteOffset = arr.byteOffset;
// returns 0
```
#### StructArray.prototype.BYTES_PER_ELEMENT
Number of bytes per view element.
```javascript
var schema = [
{
'name': 'foo',
'type': 'bool'
}
];
var StructArray = structFactory( schema );
var arr = new StructArray( 5 );
var nbytes = arr.BYTES_PER_ELEMENT;
// returns 1
```
#### StructArray.prototype.length
**Read-only** property which returns the number of view elements.
```javascript
var schema = [
{
'name': 'foo',
'type': 'bool'
}
];
var StructArray = structFactory( schema );
var arr = new StructArray( 5 );
var len = arr.length;
// returns 5
```
* * *
### Array Methods
TODO: document methods
* * *
## Notes
- 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:
- Constructors do **not** require the `new` operator.
- Accessing array elements using bracket syntax (e.g., `X[i]`) is **not** supported. Instead, one **must** use the `.get()` method.
- Accessed array elements are a view on underlying memory. Thus, mutation of accessed elements mutates the underlying buffer.
- 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.
## Examples
```javascript
var factory = require( '@stdlib/array-struct-factory' );
// Define a schema for a composite data type for storing a student's test scores:
var schema = [
{
'name': 'test_number',
'type': 'int16'
},
{
'name': 'pass',
'type': 'bool'
},
{
'name': 'correct',
'type': 'int32'
},
{
'name': 'incorrect',
'type': 'int32'
},
{
'name': 'percentage',
'type': 'float32'
}
];
// Create an array constructor for creating composite data type arrays:
var TestScoreArray = factory( schema );
console.log( 'Layout: %s', TestScoreArray.struct.layout );
// Create a new array for storing test scores:
var student1 = new TestScoreArray( 10 );
console.log( 'Byte length: %d', student1.byteLength );
```
* * *
## 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-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/array-struct-factory.svg
[npm-url]: https://npmjs.org/package/@stdlib/array-struct-factory
[test-image]: https://github.com/stdlib-js/array-struct-factory/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/array-struct-factory/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/array-struct-factory/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/array-struct-factory?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/array-struct-factory/tree/deno
[deno-readme]: https://github.com/stdlib-js/array-struct-factory/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/array-struct-factory/tree/umd
[umd-readme]: https://github.com/stdlib-js/array-struct-factory/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/array-struct-factory/tree/esm
[esm-readme]: https://github.com/stdlib-js/array-struct-factory/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/array-struct-factory/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-struct-factory/main/LICENSE
[@stdlib/array/typed]: https://github.com/stdlib-js/array-typed
[@stdlib/array/buffer]: https://github.com/stdlib-js/array-buffer
[@stdlib/dstructs/struct]: https://github.com/stdlib-js/dstructs-struct