Skip to content

Commit 8b0b780

Browse files
committed
docs: fix TypeScript declaration linting errors
1 parent 380f888 commit 8b0b780

File tree

10 files changed

+15
-9
lines changed

10 files changed

+15
-9
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ interface Options {
6868
* var x = new Int32Array( [ 1, 2, 3, 4 ] );
6969
*
7070
* var mask = [ 1, 0, 0, 1 ];
71-
* var values = [ 20, 30 ];
71+
* var values = new Int32Array( [ 20, 30 ] );
7272
*
7373
* var out = mskput( x, mask, values );
7474
* // returns <Int32Array>[ 1, 20, 30, 4 ]
@@ -81,7 +81,7 @@ interface Options {
8181
*
8282
* var x = new Int32Array( [ 1, 2, 3, 4 ] );
8383
*
84-
* var out = mskput( x, [ 1, 0, 0, 1 ], [ 30 ] );
84+
* var out = mskput( x, [ 1, 0, 0, 1 ], new Int32Array( [ 30 ] ) );
8585
* // returns <Int32Array>[ 1, 30, 30, 4 ]
8686
*
8787
* var bool = ( out === x );

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ interface Options {
6868
* var x = new Int32Array( [ 1, 2, 3, 4 ] );
6969
*
7070
* var mask = [ 0, 1, 1, 0 ];
71-
* var values = [ 20, 30 ];
71+
* var values = new Int32Array( [ 20, 30 ] );
7272
*
7373
* var out = place( x, mask, values );
7474
* // returns <Int32Array>[ 1, 20, 30, 4 ]
@@ -81,7 +81,7 @@ interface Options {
8181
*
8282
* var x = new Int32Array( [ 1, 2, 3, 4 ] );
8383
*
84-
* var out = place( x, [ 0, 1, 1, 0 ], [ 30 ] );
84+
* var out = place( x, [ 0, 1, 1, 0 ], new Int32Array( [ 30 ] ) );
8585
* // returns <Int32Array>[ 1, 30, 30, 4 ]
8686
*
8787
* var bool = ( out === x );

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ interface Options {
5959
* var x = new Int32Array( [ 1, 2, 3, 4 ] );
6060
*
6161
* var indices = [ 1, 2 ];
62-
* var values = [ 20, 30 ];
62+
* var values = new Int32Array( [ 20, 30 ] );
6363
*
6464
* var out = put( x, indices, values );
6565
* // returns <Int32Array>[ 1, 20, 30, 4 ]
@@ -72,7 +72,7 @@ interface Options {
7272
*
7373
* var x = new Int32Array( [ 1, 2, 3, 4 ] );
7474
*
75-
* var out = put( x, [ 1, 2 ], [ 30 ] );
75+
* var out = put( x, [ 1, 2 ], new Int32Array( [ 30 ] ) );
7676
* // returns <Int32Array>[ 1, 30, 30, 4 ]
7777
*
7878
* var bool = ( out === x );

lib/node_modules/@stdlib/datasets/berndt-cps-wages-1985/docs/types/index.d.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@
1818

1919
// TypeScript Version: 4.1
2020

21+
/* eslint-disable @typescript-eslint/consistent-type-definitions */
22+
2123
/**
2224
* Data for individual worker.
2325
*/

lib/node_modules/@stdlib/fs/append-file/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ interface AppendFile {
100100
* @returns error object or null
101101
*
102102
* @example
103-
* var err = appendFileSync( './beep/boop.txt', 'data to append\n' );
103+
* var err = appendFile.sync( './beep/boop.txt', 'data to append\n' );
104104
* if ( err instanceof Error ) {
105105
* throw err;
106106
* }

lib/node_modules/@stdlib/fs/write-file/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ interface WriteFile {
100100
* @returns error object or null
101101
*
102102
* @example
103-
* var err = writeFileSync( './beep/boop.txt', 'beep boop\n' );
103+
* var err = writeFile.sync( './beep/boop.txt', 'beep boop\n' );
104104
* if ( err instanceof Error ) {
105105
* throw err;
106106
* }

lib/node_modules/@stdlib/net/http2-secure-server/docs/types/index.d.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,8 @@ type http2Server = ( done: Callback ) => void;
168168
* var http2Server = factory( opts );
169169
*
170170
* @example
171+
* var readFileSync = require( '@stdlib/fs/read-file' ).sync;
172+
*
171173
* var opts = {
172174
* 'port': 7331,
173175
* 'address': '0.0.0.0',

lib/node_modules/@stdlib/number/float32/base/docs/types/index.d.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,7 @@ interface Namespace {
230230
* // returns '01000000010010010000111111011011'
231231
*
232232
* @example
233+
* var toFloat32 = require( '@stdlib/number/float64/base/to-float32' );
233234
* var str = ns.toBinaryStringf( toFloat32( -1e38 ) );
234235
* // returns '11111110100101100111011010011001'
235236
*

lib/node_modules/@stdlib/number/float32/base/to-binary-string/docs/types/index.d.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
* // returns '01000000010010010000111111011011'
3636
*
3737
* @example
38+
* var toFloat32 = require( '@stdlib/number/float64/base/to-float32' );
3839
* var str = toBinaryStringf( toFloat32( -1e38 ) );
3940
* // returns '11111110100101100111011010011001'
4041
*

lib/node_modules/@stdlib/regexp/dirname-posix/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ interface ReDirnamePosix {
3838
* Regular expression to capture a POSIX path dirname.
3939
*
4040
* @example
41-
* var ext = reExtnamePosix.REGEXP.exec( 'index.js' )[ 1 ];
41+
* var ext = reDirnamePosix.REGEXP.exec( 'index.js' )[ 1 ];
4242
* // returns '.js'
4343
*/
4444
REGEXP: RegExp;

0 commit comments

Comments
 (0)