Skip to content

Commit 3fdfa80

Browse files
committed
Document prototype property
1 parent 7c4ceca commit 3fdfa80

8 files changed

Lines changed: 96 additions & 0 deletions

File tree

lib/node_modules/@stdlib/array/float64/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+
#### Float64Array.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 Float64Array( 5 );
174+
var nbytes = arr.BYTES_PER_ELEMENT;
175+
// returns 8
176+
```
177+
166178
#### Float64Array.prototype.length
167179

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

lib/node_modules/@stdlib/array/int16/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+
#### Int16Array.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 Int16Array( 5 );
174+
var nbytes = arr.BYTES_PER_ELEMENT;
175+
// returns 2
176+
```
177+
166178
#### Int16Array.prototype.length
167179

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

lib/node_modules/@stdlib/array/int32/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+
#### Int32Array.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 Int32Array( 5 );
174+
var nbytes = arr.BYTES_PER_ELEMENT;
175+
// returns 4
176+
```
177+
166178
#### Int32Array.prototype.length
167179

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

lib/node_modules/@stdlib/array/int8/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+
#### Int8Array.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 Int8Array( 5 );
174+
var nbytes = arr.BYTES_PER_ELEMENT;
175+
// returns 1
176+
```
177+
166178
#### Int8Array.prototype.length
167179

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

lib/node_modules/@stdlib/array/uint16/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+
#### Uint16Array.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 Uint16Array( 5 );
174+
var nbytes = arr.BYTES_PER_ELEMENT;
175+
// returns 2
176+
```
177+
166178
#### Uint16Array.prototype.length
167179

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

lib/node_modules/@stdlib/array/uint32/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+
#### Uint32Array.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 Uint32Array( 5 );
174+
var nbytes = arr.BYTES_PER_ELEMENT;
175+
// returns 4
176+
```
177+
166178
#### Uint32Array.prototype.length
167179

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

lib/node_modules/@stdlib/array/uint8/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+
#### Uint8Array.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 Uint8Array( 5 );
174+
var nbytes = arr.BYTES_PER_ELEMENT;
175+
// returns 1
176+
```
177+
166178
#### Uint8Array.prototype.length
167179

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

lib/node_modules/@stdlib/array/uint8c/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+
#### Uint8ClampedArray.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 Uint8ClampedArray( 5 );
174+
var nbytes = arr.BYTES_PER_ELEMENT;
175+
// returns 1
176+
```
177+
166178
#### Uint8ClampedArray.prototype.length
167179

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

0 commit comments

Comments
 (0)