Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stdlib-js/array-base-accessors

Return element accessors for a provided array-like object.
https://github.com/stdlib-js/array-base-accessors

accessor accessors array base get getter javascript node node-js nodejs protocol set setter standardize stdlib types util utilities utility utils

Last synced: 2 months ago
JSON representation

Return element accessors for a provided array-like object.

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!



# accessors



[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] 



> Return element accessors for a provided array-like object.



## Installation



```bash

npm install @stdlib/array-base-accessors

```



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 accessors = require( '@stdlib/array-base-accessors' );

```



#### accessors( x )



Returns element accessors for a provided array-like object.



```javascript

var obj = accessors( [ 1, 2, 3, 4 ] );

// returns {...}



var bool = obj.accessorProtocol;

// returns false



var fcns = obj.accessors;

// returns [ ,  ]

```



## Notes



-   The returned object has the following properties:



    -   **accessorProtocol**: `boolean` indicating whether the provided array-like object supports the get/set protocol (i.e., uses accessors for getting and setting elements).

    -   **accessors**: a two-element array whose first element is an accessor for retrieving an array element (i.e., a getter) and whose second element is an accessor for setting an array element (i.e., a setter).



-   The getter accessor accepts two arguments:



    -   **arr**: array-like object.

    -   **idx**: element index.



-   The setter accessor accepts three arguments:



    -   **arr**: array-like object.

    -   **idx**: element index.

    -   **value**: value to set.



-   The intent of this function is to provide a minimal abstraction over how elements are accessed when operating on indexed (i.e., array-like objects supporting element accesss via integer indices using bracket `[]` syntax) and accessor (i.e., array-like objects supporting the get/set protocol in which explicit `get` and `set` methods are used for element access) array-like objects.



## Examples



```javascript

var Complex64Array = require( '@stdlib/array-complex64' );

var zeroTo = require( '@stdlib/array-base-zero-to' );

var accessors = require( '@stdlib/array-base-accessors' );



// Create an array:

var x = new Complex64Array( zeroTo( 10 ) );



// Get accessor functions for retrieving array elements:

var obj = accessors( x );

// returns {...}



// Check whether the array supports the accessor protocol:

var bool = obj.accessorProtocol;

// returns true



console.log( 'Accessor protocol: %s', bool );



// Retrieve an array element:

var v = obj.accessors[ 0 ]( x, 1 );

// returns 



console.log( 'x[1] = %s', v.toString() );

```



* * *



## 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-2024. The Stdlib [Authors][stdlib-authors].



[npm-image]: http://img.shields.io/npm/v/@stdlib/array-base-accessors.svg

[npm-url]: https://npmjs.org/package/@stdlib/array-base-accessors



[test-image]: https://github.com/stdlib-js/array-base-accessors/actions/workflows/test.yml/badge.svg?branch=main

[test-url]: https://github.com/stdlib-js/array-base-accessors/actions/workflows/test.yml?query=branch:main



[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/array-base-accessors/main.svg

[coverage-url]: https://codecov.io/github/stdlib-js/array-base-accessors?branch=main



[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg

[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im



[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-base-accessors/tree/deno

[deno-readme]: https://github.com/stdlib-js/array-base-accessors/blob/deno/README.md

[umd-url]: https://github.com/stdlib-js/array-base-accessors/tree/umd

[umd-readme]: https://github.com/stdlib-js/array-base-accessors/blob/umd/README.md

[esm-url]: https://github.com/stdlib-js/array-base-accessors/tree/esm

[esm-readme]: https://github.com/stdlib-js/array-base-accessors/blob/esm/README.md

[branches-url]: https://github.com/stdlib-js/array-base-accessors/blob/main/branches.md



[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-accessors/main/LICENSE