Skip to content

Commit c6317bc

Browse files
committed
Auto-generated commit
1 parent a82c289 commit c6317bc

File tree

3 files changed

+18
-6
lines changed

3 files changed

+18
-6
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,8 @@ var obj = arraylike2object( [ 1, 2, 3, 4 ] );
8181

8282
- The returned object has the following properties:
8383

84-
- **data**: reference to input array.
85-
- **accessorProtocol**: `boolean` indicating whether the data buffer uses accessors for getting and setting elements.
84+
- **data**: reference to the input array.
85+
- **accessorProtocol**: `boolean` indicating whether the input uses accessors for getting and setting elements.
8686
- **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).
8787

8888
- The getter accessor accepts two arguments:

docs/repl.txt

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44

55
The returned object has the following properties:
66

7-
- data: data buffer.
8-
- accessorProtocol: boolean indicating whether the data buffer uses
7+
- data: reference to input array.
8+
- accessorProtocol: boolean indicating whether the input array uses
99
accessors for getting and setting elements.
1010
- accessors: a two-element array whose first element is an accessor for
1111
retrieving an array element and whose second element is an accessor for
@@ -32,6 +32,18 @@
3232
out: Object
3333
Object containing array data.
3434

35+
out.data: ArrayLikeObject
36+
Reference to input array.
37+
38+
out.accessorProtocol: boolean
39+
Boolean indicating whether the input array use accessors for getting and
40+
setting elements.
41+
42+
out.accessors: Array<Function>
43+
A two-element array whose first element is an accessor for retrieving an
44+
array element and whose second element is an accessor for setting an
45+
array element.
46+
3547
Examples
3648
--------
3749
> var out = {{alias}}( [ 1, 2, 3, 4 ] )

lib/main.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ var accessors = require( '@stdlib/array-base-accessors' );
3434
*
3535
* - The returned object has the following properties:
3636
*
37-
* - **data**: data buffer.
38-
* - **accessorProtocol**: `boolean` indicating whether the data buffer uses accessors for getting and setting elements.
37+
* - **data**: reference to the input array.
38+
* - **accessorProtocol**: `boolean` indicating whether the input array uses accessors for getting and setting elements.
3939
* - **accessors**: a two-element array whose first element is an accessor for retrieving an array element and whose second element is an accessor for setting an array element.
4040
*
4141
* @param {Collection} x - array-like object

0 commit comments

Comments
 (0)