Skip to content

Commit 49abb6f

Browse files
kgrytekgryte
committed
Update REPL help
1 parent 0cac7ff commit 49abb6f

10 files changed

Lines changed: 552 additions & 0 deletions

File tree

‎lib/node_modules/@stdlib/array/float32/README.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,18 @@ var byteOffset = arr.byteOffset;
163163
// returns 0
164164
```
165165

166+
#### Float32Array.prototype.BYTES_PER_ELEMENT
167+
168+
Number of bytes per view element.
169+
170+
<!-- eslint-disable stdlib/require-globals -->
171+
172+
```javascript
173+
var arr = new Float32Array( 5 );
174+
var nbytes = arr.BYTES_PER_ELEMENT;
175+
// returns 4
176+
```
177+
166178
#### Float32Array.prototype.length
167179

168180
**Read-only** property which returns the number of view elements.

‎lib/node_modules/@stdlib/array/float32/docs/repl.txt‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,56 @@
101101
<Float32Array>[ 0.0, 0.0, 0.0, 0.0 ]
102102

103103

104+
{{alias}}.from( src[, map[, thisArg]] )
105+
Creates a new typed array from an array-like object or an iterable.
106+
107+
A callback is provided the following arguments:
108+
109+
- value: source value.
110+
- index: source index.
111+
112+
Parameters
113+
----------
114+
src: ArrayLike|Iterable
115+
Source of array elements.
116+
117+
map: Function (optional)
118+
Callback to invoke for each source element.
119+
120+
thisArg: Any (optional)
121+
Callback execution context.
122+
123+
Returns
124+
-------
125+
out: Float32Array
126+
A typed array.
127+
128+
Examples
129+
--------
130+
> function mapFcn( v ) { return v * 2.0; };
131+
> var arr = {{alias}}.from( [ 1.0, -1.0 ], mapFcn )
132+
<Float32Array>[ 2.0, -2.0 ]
133+
134+
135+
{{alias}}.of( element0[, element1[, ...[, elementN]]] )
136+
Creates a new typed array from a variable number of arguments.
137+
138+
Parameters
139+
----------
140+
element: number
141+
Array elements.
142+
143+
Returns
144+
-------
145+
out: Float32Array
146+
A typed array.
147+
148+
Examples
149+
--------
150+
> var arr = {{alias}}.of( 2.0, -2.0 )
151+
<Float32Array>[ 2.0, -2.0 ]
152+
153+
104154
{{alias}}.BYTES_PER_ELEMENT
105155
Number of bytes per view element.
106156

@@ -151,6 +201,16 @@
151201
0
152202

153203

204+
{{alias}}.prototype.BYTES_PER_ELEMENT
205+
Number of bytes per view element.
206+
207+
Examples
208+
--------
209+
> var arr = new {{alias}}( 5 );
210+
> arr.BYTES_PER_ELEMENT
211+
4
212+
213+
154214
{{alias}}.prototype.length
155215
Read-only property which returns the number of view elements.
156216

‎lib/node_modules/@stdlib/array/float64/docs/repl.txt‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,56 @@
101101
<Float64Array>[ 0.0, 0.0, 0.0, 0.0 ]
102102

103103

104+
{{alias}}.from( src[, map[, thisArg]] )
105+
Creates a new typed array from an array-like object or an iterable.
106+
107+
A callback is provided the following arguments:
108+
109+
- value: source value.
110+
- index: source index.
111+
112+
Parameters
113+
----------
114+
src: ArrayLike|Iterable
115+
Source of array elements.
116+
117+
map: Function (optional)
118+
Callback to invoke for each source element.
119+
120+
thisArg: Any (optional)
121+
Callback execution context.
122+
123+
Returns
124+
-------
125+
out: Float64Array
126+
A typed array.
127+
128+
Examples
129+
--------
130+
> function mapFcn( v ) { return v * 2.0; };
131+
> var arr = {{alias}}.from( [ 1.0, -1.0 ], mapFcn )
132+
<Float64Array>[ 2.0, -2.0 ]
133+
134+
135+
{{alias}}.of( element0[, element1[, ...[, elementN]]] )
136+
Creates a new typed array from a variable number of arguments.
137+
138+
Parameters
139+
----------
140+
element: number
141+
Array elements.
142+
143+
Returns
144+
-------
145+
out: Float64Array
146+
A typed array.
147+
148+
Examples
149+
--------
150+
> var arr = {{alias}}.of( 2.0, -2.0 )
151+
<Float64Array>[ 2.0, -2.0 ]
152+
153+
104154
{{alias}}.BYTES_PER_ELEMENT
105155
Number of bytes per view element.
106156

@@ -151,6 +201,16 @@
151201
0
152202

153203

204+
{{alias}}.prototype.BYTES_PER_ELEMENT
205+
Number of bytes per view element.
206+
207+
Examples
208+
--------
209+
> var arr = new {{alias}}( 5 );
210+
> arr.BYTES_PER_ELEMENT
211+
8
212+
213+
154214
{{alias}}.prototype.length
155215
Read-only property which returns the number of view elements.
156216

‎lib/node_modules/@stdlib/array/int16/docs/repl.txt‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,56 @@
101101
<Int16Array>[ 0, 0, 0, 0 ]
102102

103103

104+
{{alias}}.from( src[, map[, thisArg]] )
105+
Creates a new typed array from an array-like object or an iterable.
106+
107+
A callback is provided the following arguments:
108+
109+
- value: source value.
110+
- index: source index.
111+
112+
Parameters
113+
----------
114+
src: ArrayLike|Iterable
115+
Source of array elements.
116+
117+
map: Function (optional)
118+
Callback to invoke for each source element.
119+
120+
thisArg: Any (optional)
121+
Callback execution context.
122+
123+
Returns
124+
-------
125+
out: Int16Array
126+
A typed array.
127+
128+
Examples
129+
--------
130+
> function mapFcn( v ) { return v * 2; };
131+
> var arr = {{alias}}.from( [ 1, 2 ], mapFcn )
132+
<Int16Array>[ 2, 4 ]
133+
134+
135+
{{alias}}.of( element0[, element1[, ...[, elementN]]] )
136+
Creates a new typed array from a variable number of arguments.
137+
138+
Parameters
139+
----------
140+
element: number
141+
Array elements.
142+
143+
Returns
144+
-------
145+
out: Int16Array
146+
A typed array.
147+
148+
Examples
149+
--------
150+
> var arr = {{alias}}.of( 1, 2 )
151+
<Int16Array>[ 1, 2 ]
152+
153+
104154
{{alias}}.BYTES_PER_ELEMENT
105155
Number of bytes per view element.
106156

@@ -151,6 +201,16 @@
151201
0
152202

153203

204+
{{alias}}.prototype.BYTES_PER_ELEMENT
205+
Number of bytes per view element.
206+
207+
Examples
208+
--------
209+
> var arr = new {{alias}}( 5 );
210+
> arr.BYTES_PER_ELEMENT
211+
2
212+
213+
154214
{{alias}}.prototype.length
155215
Read-only property which returns the number of view elements.
156216

‎lib/node_modules/@stdlib/array/int32/docs/repl.txt‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,56 @@
101101
<Int32Array>[ 0, 0, 0, 0 ]
102102

103103

104+
{{alias}}.from( src[, map[, thisArg]] )
105+
Creates a new typed array from an array-like object or an iterable.
106+
107+
A callback is provided the following arguments:
108+
109+
- value: source value.
110+
- index: source index.
111+
112+
Parameters
113+
----------
114+
src: ArrayLike|Iterable
115+
Source of array elements.
116+
117+
map: Function (optional)
118+
Callback to invoke for each source element.
119+
120+
thisArg: Any (optional)
121+
Callback execution context.
122+
123+
Returns
124+
-------
125+
out: Int32Array
126+
A typed array.
127+
128+
Examples
129+
--------
130+
> function mapFcn( v ) { return v * 2; };
131+
> var arr = {{alias}}.from( [ 1, 2 ], mapFcn )
132+
<Int32Array>[ 2, 4 ]
133+
134+
135+
{{alias}}.of( element0[, element1[, ...[, elementN]]] )
136+
Creates a new typed array from a variable number of arguments.
137+
138+
Parameters
139+
----------
140+
element: number
141+
Array elements.
142+
143+
Returns
144+
-------
145+
out: Int32Array
146+
A typed array.
147+
148+
Examples
149+
--------
150+
> var arr = {{alias}}.of( 1, 2 )
151+
<Int32Array>[ 1, 2 ]
152+
153+
104154
{{alias}}.BYTES_PER_ELEMENT
105155
Number of bytes per view element.
106156

@@ -151,6 +201,16 @@
151201
0
152202

153203

204+
{{alias}}.prototype.BYTES_PER_ELEMENT
205+
Number of bytes per view element.
206+
207+
Examples
208+
--------
209+
> var arr = new {{alias}}( 5 );
210+
> arr.BYTES_PER_ELEMENT
211+
4
212+
213+
154214
{{alias}}.prototype.length
155215
Read-only property which returns the number of view elements.
156216

‎lib/node_modules/@stdlib/array/int8/docs/repl.txt‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,56 @@
101101
<Int8Array>[ 0, 0, 0, 0 ]
102102

103103

104+
{{alias}}.from( src[, map[, thisArg]] )
105+
Creates a new typed array from an array-like object or an iterable.
106+
107+
A callback is provided the following arguments:
108+
109+
- value: source value.
110+
- index: source index.
111+
112+
Parameters
113+
----------
114+
src: ArrayLike|Iterable
115+
Source of array elements.
116+
117+
map: Function (optional)
118+
Callback to invoke for each source element.
119+
120+
thisArg: Any (optional)
121+
Callback execution context.
122+
123+
Returns
124+
-------
125+
out: Int8Array
126+
A typed array.
127+
128+
Examples
129+
--------
130+
> function mapFcn( v ) { return v * 2; };
131+
> var arr = {{alias}}.from( [ 1, 2 ], mapFcn )
132+
<Int8Array>[ 2, 4 ]
133+
134+
135+
{{alias}}.of( element0[, element1[, ...[, elementN]]] )
136+
Creates a new typed array from a variable number of arguments.
137+
138+
Parameters
139+
----------
140+
element: number
141+
Array elements.
142+
143+
Returns
144+
-------
145+
out: Int8Array
146+
A typed array.
147+
148+
Examples
149+
--------
150+
> var arr = {{alias}}.of( 1, 2 )
151+
<Int8Array>[ 1, 2 ]
152+
153+
104154
{{alias}}.BYTES_PER_ELEMENT
105155
Number of bytes per view element.
106156

@@ -151,6 +201,16 @@
151201
0
152202

153203

204+
{{alias}}.prototype.BYTES_PER_ELEMENT
205+
Number of bytes per view element.
206+
207+
Examples
208+
--------
209+
> var arr = new {{alias}}( 5 );
210+
> arr.BYTES_PER_ELEMENT
211+
1
212+
213+
154214
{{alias}}.prototype.length
155215
Read-only property which returns the number of view elements.
156216

0 commit comments

Comments
 (0)