Skip to content

Commit 1a9294b

Browse files
kgrytekgryte
committed
fix: prevent index increments to zero
1 parent b611203 commit 1a9294b

5 files changed

Lines changed: 30 additions & 2 deletions

File tree

‎lib/node_modules/@stdlib/slice/ctor/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ The constructor accepts the following arguments:
7474

7575
- **start**: starting index (inclusive).
7676
- **stop**: ending index (exclusive).
77-
- **step**: index increment. Default: `null`.
77+
- **step**: index increment. A numeric index increment argument must be a non-zero integer value. Default: `null`.
7878

7979
* * *
8080

‎lib/node_modules/@stdlib/slice/ctor/docs/repl.txt‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@
3030
Ending index (exclusive).
3131

3232
step: integer|null|undefined (optional)
33-
Index increment. Default: null.
33+
Index increment. A numeric index increment argument should be a non-zero
34+
integer value. Default: null.
3435

3536
Returns
3637
-------

‎lib/node_modules/@stdlib/slice/ctor/docs/types/index.d.ts‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -305,6 +305,7 @@ interface Constructor {
305305
* @throws first argument must be an integer
306306
* @throws second argument must be an integer
307307
* @throws third argument must be an integer
308+
* @throws third argument cannot be zero
308309
* @returns Slice instance
309310
*
310311
* @example
@@ -330,6 +331,7 @@ interface Constructor {
330331
* @param step - index increment
331332
* @throws second argument must be an integer
332333
* @throws third argument must be an integer
334+
* @throws third argument cannot be zero
333335
* @returns Slice instance
334336
*
335337
* @example
@@ -368,6 +370,7 @@ interface Constructor {
368370
* @param step - index increment
369371
* @throws first argument must be an integer
370372
* @throws third argument must be an integer
373+
* @throws third argument cannot be zero
371374
* @returns Slice instance
372375
*
373376
* @example
@@ -405,6 +408,7 @@ interface Constructor {
405408
* @param stop - ending index (exclusive)
406409
* @param step - index increment
407410
* @throws third argument must be an integer
411+
* @throws third argument cannot be zero
408412
* @returns Slice instance
409413
*
410414
* @example
@@ -748,6 +752,7 @@ interface Constructor {
748752
* @throws first argument must be an integer
749753
* @throws second argument must be an integer
750754
* @throws third argument must be an integer
755+
* @throws third argument cannot be zero
751756
* @returns Slice instance
752757
*
753758
* @example
@@ -773,6 +778,7 @@ interface Constructor {
773778
* @param step - index increment
774779
* @throws second argument must be an integer
775780
* @throws third argument must be an integer
781+
* @throws third argument cannot be zero
776782
* @returns Slice instance
777783
*
778784
* @example
@@ -811,6 +817,7 @@ interface Constructor {
811817
* @param step - index increment
812818
* @throws first argument must be an integer
813819
* @throws third argument must be an integer
820+
* @throws third argument cannot be zero
814821
* @returns Slice instance
815822
*
816823
* @example
@@ -848,6 +855,7 @@ interface Constructor {
848855
* @param stop - ending index (exclusive)
849856
* @param step - index increment
850857
* @throws third argument must be an integer
858+
* @throws third argument cannot be zero
851859
* @returns Slice instance
852860
*
853861
* @example
@@ -924,6 +932,7 @@ interface Constructor {
924932
* @throws first argument must be an integer or null
925933
* @throws second argument must be an integer or null
926934
* @throws third argument must be an integer or null
935+
* @throws third argument cannot be zero
927936
* @returns Slice instance
928937
*
929938
* @example

‎lib/node_modules/@stdlib/slice/ctor/lib/main.js‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ function isValid( value ) {
6969
* @throws {TypeError} first argument must be an integer, null, or undefined
7070
* @throws {TypeError} second argument must be an integer, null, or undefined
7171
* @throws {TypeError} third argument must be an integer, null, or undefined
72+
* @throws {RangeError} third argument cannot be zero
7273
* @returns {Slice} Slice instance
7374
*
7475
* @example
@@ -145,6 +146,8 @@ function Slice() {
145146
}
146147
if ( !isValid( step ) ) {
147148
throw new TypeError( format( 'invalid argument. Third argument must be an integer, null, or undefined. Value: `%s`.', step ) );
149+
} else if ( step === 0 ) {
150+
throw new RangeError( format( 'invalid argument. Third argument cannot be zero. Value: `%s`.', step ) );
148151
}
149152
this._start = ( start === void 0 ) ? null : start;
150153
this._stop = ( stop === void 0 ) ? null : stop;

‎lib/node_modules/@stdlib/slice/ctor/test/test.js‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -564,6 +564,21 @@ tape( 'the constructor throws an error if provided a third argument which is nei
564564
}
565565
});
566566

567+
tape( 'the constructor throws an error if provided a third argument equal to zero', function test( t ) {
568+
var slice = Slice;
569+
t.throws( foo, RangeError, 'throws an error' );
570+
t.throws( bar, RangeError, 'throws an error' );
571+
t.end();
572+
573+
function foo() {
574+
new Slice( 2, 10, 0 ); // eslint-disable-line no-new
575+
}
576+
577+
function bar() {
578+
slice( 2, 10, 0 );
579+
}
580+
});
581+
567582
tape( 'a slice has a `start` property specifying the starting index', function test( t ) {
568583
var s;
569584

0 commit comments

Comments
 (0)