Skip to content

Commit 8f9028b

Browse files
PlaneshifterPlaneshifter
committed
Update TypeScript test descriptions
1 parent 03cd443 commit 8f9028b

File tree

684 files changed

+1426
-1427
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

684 files changed

+1426
-1427
lines changed

‎lib/node_modules/@stdlib/array/datespace/docs/types/test.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ import datespace = require( './index' );
3131
datespace( start, stop, 30, { 'round': 'floor' } ); // $ExpectType Date[]
3232
}
3333

34-
// The function does not compile if provided values other `Date` objects, Unix timestamps, JavaScript timestamps, or date strings for the first two parameters...
34+
// The compiler throws an error if the function is provided values other `Date` objects, Unix timestamps, JavaScript timestamps, or date strings for the first two parameters...
3535
{
3636
const stop = '2014-12-02T07:00:54.973Z';
3737
const start = new Date( stop ).getTime() - 60000;
@@ -49,7 +49,7 @@ import datespace = require( './index' );
4949
datespace( start, ( x: number ): number => x ); // $ExpectError
5050
}
5151

52-
// The function does not compile if provided a value other than a number or object for the third parameter...
52+
// The compiler throws an error if the function is provided a value other than a number or object for the third parameter...
5353
{
5454
const stop = '2014-12-02T07:00:54.973Z';
5555
const start = new Date( stop ).getTime() - 60000;
@@ -79,7 +79,7 @@ import datespace = require( './index' );
7979
datespace( start, stop, 10, { 'round': ( x: number ): number => x } ); // $ExpectError
8080
}
8181

82-
// The function does not compile if provided insufficient arguments...
82+
// The compiler throws an error if the function is provided insufficient arguments...
8383
{
8484
datespace(); // $ExpectError
8585
datespace( new Date() ); // $ExpectError

‎lib/node_modules/@stdlib/array/incrspace/docs/types/test.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ import incrspace = require( './index' );
2727
incrspace( 0, 10 ); // $ExpectType number[]
2828
}
2929

30-
// The function does not compile if provided values other than two numbers for the first two parameters...
30+
// The compiler throws an error if the function is provided values other than two numbers for the first two parameters...
3131
{
3232
incrspace( true, 10 ); // $ExpectError
3333
incrspace( false, 10 ); // $ExpectError
@@ -44,7 +44,7 @@ import incrspace = require( './index' );
4444
incrspace( 8, ( x: number ): number => x ); // $ExpectError
4545
}
4646

47-
// The function does not compile if provided a value other than a number for the third parameter...
47+
// The compiler throws an error if the function is provided a value other than a number for the third parameter...
4848
{
4949
incrspace( 3, 20, true ); // $ExpectError
5050
incrspace( 4, 20, false ); // $ExpectError
@@ -53,7 +53,7 @@ import incrspace = require( './index' );
5353
incrspace( 9, 20, ( x: number ): number => x ); // $ExpectError
5454
}
5555

56-
// The function does not compile if provided insufficient arguments...
56+
// The compiler throws an error if the function is provided insufficient arguments...
5757
{
5858
incrspace(); // $ExpectError
5959
incrspace( 3 ); // $ExpectError

‎lib/node_modules/@stdlib/array/logspace/docs/types/test.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ import logspace = require( './index' );
2727
logspace( 0, 10 ); // $ExpectType number[]
2828
}
2929

30-
// The function does not compile if provided values other than two numbers for the first two parameters...
30+
// The compiler throws an error if the function is provided values other than two numbers for the first two parameters...
3131
{
3232
logspace( true, 10 ); // $ExpectError
3333
logspace( false, 10 ); // $ExpectError
@@ -44,7 +44,7 @@ import logspace = require( './index' );
4444
logspace( 8, ( x: number ): number => x ); // $ExpectError
4545
}
4646

47-
// The function does not compile if provided a value other than a number for the third parameter...
47+
// The compiler throws an error if the function is provided a value other than a number for the third parameter...
4848
{
4949
logspace( 3, 20, true ); // $ExpectError
5050
logspace( 4, 20, false ); // $ExpectError
@@ -53,7 +53,7 @@ import logspace = require( './index' );
5353
logspace( 9, 20, ( x: number ): number => x ); // $ExpectError
5454
}
5555

56-
// The function does not compile if provided insufficient arguments...
56+
// The compiler throws an error if the function is provided insufficient arguments...
5757
{
5858
logspace(); // $ExpectError
5959
logspace( 3 ); // $ExpectError

‎lib/node_modules/@stdlib/array/promotion-rules/docs/types/test.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ import promotionRules = require( './index' );
3939
promotionRules( 'bar', 'float32' ); // $ExpectType null
4040
}
4141

42-
// The function does not compile if provided a first argument that is not a string...
42+
// The compiler throws an error if the function is provided a first argument that is not a string...
4343
{
4444
promotionRules( 123, 'float64' ); // $ExpectError
4545
promotionRules( true, 'float64' ); // $ExpectError
@@ -49,7 +49,7 @@ import promotionRules = require( './index' );
4949
promotionRules( ( x: number ): number => x, 'float64' ); // $ExpectError
5050
}
5151

52-
// The function does not compile if provided a second argument that is not a string...
52+
// The compiler throws an error if the function is provided a second argument that is not a string...
5353
{
5454
promotionRules( 'int32', 123 ); // $ExpectError
5555
promotionRules( 'int32', true ); // $ExpectError
@@ -59,7 +59,7 @@ import promotionRules = require( './index' );
5959
promotionRules( 'int32', ( x: number ): number => x ); // $ExpectError
6060
}
6161

62-
// The function does not compile if provided more than one argument...
62+
// The compiler throws an error if the function is provided more than one argument...
6363
{
6464
promotionRules( 'float32' ); // $ExpectError
6565
promotionRules( 'float32', 'int32', {} ); // $ExpectError

‎lib/node_modules/@stdlib/array/reviver/docs/types/test.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ import reviveTypedArray = require( './index' );
3030
reviveTypedArray( 'foo', o ); // $ExpectType any
3131
}
3232

33-
// The function does not compile if provided a first argument that is not a string...
33+
// The compiler throws an error if the function is provided a first argument that is not a string...
3434
{
3535
reviveTypedArray( true, 1 ); // $ExpectError
3636
reviveTypedArray( false, 1 ); // $ExpectError
@@ -42,7 +42,7 @@ import reviveTypedArray = require( './index' );
4242
reviveTypedArray( ( x: number ): number => x, 1 ); // $ExpectError
4343
}
4444

45-
// The function does not compile if provided insufficient arguments...
45+
// The compiler throws an error if the function is provided insufficient arguments...
4646
{
4747
reviveTypedArray(); // $ExpectError
4848
reviveTypedArray( 'beep' ); // $ExpectError

‎lib/node_modules/@stdlib/assert/contains/docs/types/test.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ import contains = require( './index' );
3030
contains( [ 1, 2, 3, 4, 5, 6 ], 2, 3 ); // $ExpectType boolean
3131
}
3232

33-
// The function does not compile if provided arguments having invalid types...
33+
// The compiler throws an error if the function is provided arguments having invalid types...
3434
{
3535
contains( true, 'd' ); // $ExpectError
3636
contains( false, 'd' ); // $ExpectError
@@ -44,7 +44,7 @@ import contains = require( './index' );
4444
contains( 'abd', 'a', ( x: number ): number => x ); // $ExpectError
4545
}
4646

47-
// The function does not compile if provided insufficient arguments...
47+
// The compiler throws an error if the function is provided insufficient arguments...
4848
{
4949
contains(); // $ExpectError
5050
contains( 'abc' ); // $ExpectError

‎lib/node_modules/@stdlib/assert/has-utf16-surrogate-pair-at/docs/types/test.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ import hasUTF16SurrogatePairAt = require( './index' );
2727
hasUTF16SurrogatePairAt( '🌷', 1 ); // $ExpectType boolean
2828
}
2929

30-
// The function does not compile if provided incorrect arguments...
30+
// The compiler throws an error if the function is provided incorrect arguments...
3131
{
3232
hasUTF16SurrogatePairAt( false, 3 ); // $ExpectError
3333
hasUTF16SurrogatePairAt( {}, 3 ); // $ExpectError

‎lib/node_modules/@stdlib/assert/instance-of/docs/types/test.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ import instanceOf = require( './index' );
2727
instanceOf( {}, Object ); // $ExpectType boolean
2828
}
2929

30-
// The function does not compile if provided a second argument that is not a function...
30+
// The compiler throws an error if the function is provided a second argument that is not a function...
3131
{
3232
instanceOf( [], [] ); // $ExpectError
3333
instanceOf( [], {} ); // $ExpectError
@@ -38,7 +38,7 @@ import instanceOf = require( './index' );
3838
instanceOf( [], false ); // $ExpectError
3939
}
4040

41-
// The function does not compile if provided insufficient arguments...
41+
// The compiler throws an error if the function is provided insufficient arguments...
4242
{
4343
instanceOf(); // $ExpectError
4444
instanceOf( [] ); // $ExpectError

‎lib/node_modules/@stdlib/assert/is-between-array/docs/types/test.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ import isBetweenArray = require( './index' );
2929
isBetweenArray( arr, 3.14, 4.0, 'open' ); // $ExpectType boolean
3030
}
3131

32-
// The function does not compile if provided a fourth argument that is not a recognized string...
32+
// The compiler throws an error if the function is provided a fourth argument that is not a recognized string...
3333
{
3434
const arr = [ 3.0, 3.14, 4.0 ];
3535
isBetweenArray( arr, 3.14, 4.0, [] ); // $ExpectError
@@ -41,7 +41,7 @@ import isBetweenArray = require( './index' );
4141
isBetweenArray( arr, 3.14, 4.0, false ); // $ExpectError
4242
}
4343

44-
// The function does not compile if provided a fifth argument that is not a recognized string...
44+
// The compiler throws an error if the function is provided a fifth argument that is not a recognized string...
4545
{
4646
const arr = [ 3.0, 3.14, 4.0 ];
4747
isBetweenArray( arr, 3.14, 4.0, 'open', [] ); // $ExpectError
@@ -53,7 +53,7 @@ import isBetweenArray = require( './index' );
5353
isBetweenArray( arr, 3.14, 4.0, 'open', false ); // $ExpectError
5454
}
5555

56-
// The function does not compile if provided insufficient arguments...
56+
// The compiler throws an error if the function is provided insufficient arguments...
5757
{
5858
const arr = [ 3.0, 3.14, 4.0 ];
5959
isBetweenArray(); // $ExpectError

‎lib/node_modules/@stdlib/assert/is-between/docs/types/test.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import isBetween = require( './index' );
2828
isBetween( 3.14, 3.14, 4.0, 'open' ); // $ExpectType boolean
2929
}
3030

31-
// The function does not compile if provided a fourth argument that is not a recognized string...
31+
// The compiler throws an error if the function is provided a fourth argument that is not a recognized string...
3232
{
3333
isBetween( 3.14, 3.14, 4.0, [] ); // $ExpectError
3434
isBetween( 3.14, 3.14, 4.0, {} ); // $ExpectError
@@ -39,7 +39,7 @@ import isBetween = require( './index' );
3939
isBetween( 3.14, 3.14, 4.0, false ); // $ExpectError
4040
}
4141

42-
// The function does not compile if provided a fifth argument that is not a recognized string...
42+
// The compiler throws an error if the function is provided a fifth argument that is not a recognized string...
4343
{
4444
isBetween( 3.14, 3.14, 4.0, 'open', [] ); // $ExpectError
4545
isBetween( 3.14, 3.14, 4.0, 'open', {} ); // $ExpectError
@@ -50,7 +50,7 @@ import isBetween = require( './index' );
5050
isBetween( 3.14, 3.14, 4.0, 'open', false ); // $ExpectError
5151
}
5252

53-
// The function does not compile if provided insufficient arguments...
53+
// The compiler throws an error if the function is provided insufficient arguments...
5454
{
5555
isBetween(); // $ExpectError
5656
isBetween( 1 ); // $ExpectError

0 commit comments

Comments
 (0)