Skip to content

Commit 487ade8

Browse files
kgrytekgryte
committed
Update types and document properties as read-only
1 parent c9ce170 commit 487ade8

File tree

3 files changed

+19
-14
lines changed

3 files changed

+19
-14
lines changed

‎lib/node_modules/@stdlib/array/complex64/docs/types/index.d.ts‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
/// <reference types="@stdlib/types"/>
2222

2323
import { Iterator as Iter, IterableIterator } from '@stdlib/types/iter';
24-
import { ArrayLike, TypedArray, Complex64Array as Complex64ArrayInterface } from '@stdlib/types/array';
24+
import { ArrayLike, RealOrComplexTypedArray, Complex64Array as Complex64ArrayInterface } from '@stdlib/types/array';
2525
import { ComplexLike, Complex64 } from '@stdlib/types/object';
2626
import ArrayBuffer = require( '@stdlib/array/buffer' );
2727

@@ -99,7 +99,7 @@ declare class Complex64Array implements Complex64ArrayInterface {
9999
* var len = arr.length;
100100
* // returns 2
101101
*/
102-
constructor( arg?: number | TypedArray | ArrayLike<number | ComplexLike> | ArrayBuffer | Iterable<number | ComplexLike>, byteOffset?: number, length?: number ); // tslint:disable-line:max-line-length
102+
constructor( arg?: number | RealOrComplexTypedArray | ArrayLike<number | ComplexLike> | ArrayBuffer | Iterable<number | ComplexLike>, byteOffset?: number, length?: number ); // tslint:disable-line:max-line-length
103103

104104
/**
105105
* Length (in bytes) of the array.
@@ -132,7 +132,7 @@ declare class Complex64Array implements Complex64ArrayInterface {
132132
* var nbytes = arr.BYTES_PER_ELEMENT;
133133
* // returns 8
134134
*/
135-
readonly BYTES_PER_ELEMENT: number;
135+
readonly BYTES_PER_ELEMENT: 8;
136136

137137
/**
138138
* Number of array elements.
@@ -290,7 +290,7 @@ declare class Complex64Array implements Complex64ArrayInterface {
290290
* im = imagf( z );
291291
* // returns -1.0
292292
*/
293-
set( value: ArrayLike<number | ComplexLike> | Complex64Array | ComplexLike, i?: number ): void; // tslint:disable-line:max-line-length
293+
set( value: ArrayLike<number | ComplexLike> | RealOrComplexTypedArray | ComplexLike, i?: number ): void; // tslint:disable-line:max-line-length
294294
}
295295

296296
/**
@@ -364,7 +364,7 @@ interface Constructor {
364364
* var len = arr.length;
365365
* // returns 2
366366
*/
367-
new( arg?: number | TypedArray | ArrayLike<number | ComplexLike> | ArrayBuffer | Iterable<number | ComplexLike>, byteOffset?: number, length?: number ): Complex64Array; // tslint-disable-line max-line-length
367+
new( arg?: number | RealOrComplexTypedArray | ArrayLike<number | ComplexLike> | ArrayBuffer | Iterable<number | ComplexLike>, byteOffset?: number, length?: number ): Complex64Array; // tslint-disable-line max-line-length
368368

369369
/**
370370
* 64-bit complex number array constructor.
@@ -433,7 +433,7 @@ interface Constructor {
433433
* var len = arr.length;
434434
* // returns 2
435435
*/
436-
( arg?: number | TypedArray | ArrayLike<number | ComplexLike> | ArrayBuffer | Iterable<number | ComplexLike>, byteOffset?: number, length?: number ): Complex64Array; // tslint-disable-line max-line-length
436+
( arg?: number | RealOrComplexTypedArray | ArrayLike<number | ComplexLike> | ArrayBuffer | Iterable<number | ComplexLike>, byteOffset?: number, length?: number ): Complex64Array; // tslint-disable-line max-line-length
437437

438438
/**
439439
* Constructor name.
@@ -442,7 +442,7 @@ interface Constructor {
442442
* var str = Complex64Array.name;
443443
* // returns 'Complex64Array'
444444
*/
445-
readonly name: string;
445+
readonly name: 'Complex64Array';
446446

447447
/**
448448
* Size (in bytes) of each array element.
@@ -451,7 +451,7 @@ interface Constructor {
451451
* var nbytes = Complex64Array.BYTES_PER_ELEMENT;
452452
* // returns 8
453453
*/
454-
readonly BYTES_PER_ELEMENT: number;
454+
readonly BYTES_PER_ELEMENT: 8;
455455

456456
/**
457457
* Creates a new 64-bit complex number array from an array-like object or an iterable.
@@ -495,7 +495,7 @@ interface Constructor {
495495
* var len = arr.length;
496496
* // returns 1
497497
*/
498-
from( src: ArrayLike<number | ComplexLike> | Iterable<number | ComplexLike>, clbk?: Function, thisArg?: any ): Complex64Array; // tslint:disable-line:max-line-length
498+
from( src: ArrayLike<number | ComplexLike> | RealOrComplexTypedArray | Iterable<number | ComplexLike>, clbk?: Function, thisArg?: any ): Complex64Array; // tslint:disable-line:max-line-length
499499

500500
/**
501501
* Creates a new 64-bit complex number array from a variable number of arguments.

‎lib/node_modules/@stdlib/array/complex64/lib/index.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,9 +86,9 @@
8686

8787
// MODULES //
8888

89-
var Complex64Array = require( './main.js' );
89+
var main = require( './main.js' );
9090

9191

9292
// EXPORTS //
9393

94-
module.exports = Complex64Array;
94+
module.exports = main;

‎lib/node_modules/@stdlib/array/complex64/lib/main.js‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
/* eslint-disable no-restricted-syntax, max-lines */
1+
/* eslint-disable no-restricted-syntax, max-lines, no-invalid-this */
22

33
/**
44
* @license Apache-2.0
@@ -18,8 +18,6 @@
1818
* limitations under the License.
1919
*/
2020

21-
/* eslint-disable no-invalid-this */
22-
2321
'use strict';
2422

2523
// MODULES //
@@ -318,6 +316,7 @@ function Complex64Array() {
318316
*
319317
* @name BYTES_PER_ELEMENT
320318
* @memberof Complex64Array
319+
* @readonly
321320
* @type {PositiveInteger}
322321
* @default 8
323322
*
@@ -332,6 +331,7 @@ setReadOnly( Complex64Array, 'BYTES_PER_ELEMENT', BYTES_PER_ELEMENT );
332331
*
333332
* @name name
334333
* @memberof Complex64Array
334+
* @readonly
335335
* @type {string}
336336
* @default 'Complex64Array'
337337
*
@@ -551,6 +551,7 @@ setReadOnly( Complex64Array, 'of', function of() {
551551
*
552552
* @name buffer
553553
* @memberof Complex64Array.prototype
554+
* @readonly
554555
* @type {ArrayBuffer}
555556
*
556557
* @example
@@ -568,6 +569,7 @@ setReadOnlyAccessor( Complex64Array.prototype, 'buffer', function get() {
568569
*
569570
* @name byteLength
570571
* @memberof Complex64Array.prototype
572+
* @readonly
571573
* @type {NonNegativeInteger}
572574
*
573575
* @example
@@ -585,6 +587,7 @@ setReadOnlyAccessor( Complex64Array.prototype, 'byteLength', function get() {
585587
*
586588
* @name byteOffset
587589
* @memberof Complex64Array.prototype
590+
* @readonly
588591
* @type {NonNegativeInteger}
589592
*
590593
* @example
@@ -602,6 +605,7 @@ setReadOnlyAccessor( Complex64Array.prototype, 'byteOffset', function get() {
602605
*
603606
* @name BYTES_PER_ELEMENT
604607
* @memberof Complex64Array.prototype
608+
* @readonly
605609
* @type {PositiveInteger}
606610
* @default 8
607611
*
@@ -840,6 +844,7 @@ setReadOnly( Complex64Array.prototype, 'get', function get( idx ) {
840844
*
841845
* @name length
842846
* @memberof Complex64Array.prototype
847+
* @readonly
843848
* @type {NonNegativeInteger}
844849
*
845850
* @example

0 commit comments

Comments
 (0)