Skip to content

Commit 811b1f6

Browse files
authored
improve jsdoc for array fill methods (microsoft#43627)
1 parent fde2c55 commit 811b1f6

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

src/lib/es2015.core.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ interface Array<T> {
2323
findIndex(predicate: (value: T, index: number, obj: T[]) => unknown, thisArg?: any): number;
2424

2525
/**
26-
* Returns the this object after filling the section identified by start and end with value
26+
* Changes all array elements from `start` to `end` index to a static `value` and returns the modified array
2727
* @param value value to fill array section with
2828
* @param start index to start filling the array at. If start is negative, it is treated as
2929
* length+start where length is the length of the array.

src/lib/es2020.bigint.d.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ interface BigInt64Array {
164164
every(predicate: (value: bigint, index: number, array: BigInt64Array) => boolean, thisArg?: any): boolean;
165165

166166
/**
167-
* Returns the this object after filling the section identified by start and end with value
167+
* Changes all array elements from `start` to `end` index to a static `value` and returns the modified array
168168
* @param value value to fill array section with
169169
* @param start index to start filling the array at. If start is negative, it is treated as
170170
* length+start where length is the length of the array.
@@ -436,7 +436,7 @@ interface BigUint64Array {
436436
every(predicate: (value: bigint, index: number, array: BigUint64Array) => boolean, thisArg?: any): boolean;
437437

438438
/**
439-
* Returns the this object after filling the section identified by start and end with value
439+
* Changes all array elements from `start` to `end` index to a static `value` and returns the modified array
440440
* @param value value to fill array section with
441441
* @param start index to start filling the array at. If start is negative, it is treated as
442442
* length+start where length is the length of the array.

src/lib/es5.d.ts

+9-9
Original file line numberDiff line numberDiff line change
@@ -1776,7 +1776,7 @@ interface Int8Array {
17761776
every(predicate: (value: number, index: number, array: Int8Array) => unknown, thisArg?: any): boolean;
17771777

17781778
/**
1779-
* Returns the this object after filling the section identified by start and end with value
1779+
* Changes all array elements from `start` to `end` index to a static `value` and returns the modified array
17801780
* @param value value to fill array section with
17811781
* @param start index to start filling the array at. If start is negative, it is treated as
17821782
* length+start where length is the length of the array.
@@ -2058,7 +2058,7 @@ interface Uint8Array {
20582058
every(predicate: (value: number, index: number, array: Uint8Array) => unknown, thisArg?: any): boolean;
20592059

20602060
/**
2061-
* Returns the this object after filling the section identified by start and end with value
2061+
* Changes all array elements from `start` to `end` index to a static `value` and returns the modified array
20622062
* @param value value to fill array section with
20632063
* @param start index to start filling the array at. If start is negative, it is treated as
20642064
* length+start where length is the length of the array.
@@ -2340,7 +2340,7 @@ interface Uint8ClampedArray {
23402340
every(predicate: (value: number, index: number, array: Uint8ClampedArray) => unknown, thisArg?: any): boolean;
23412341

23422342
/**
2343-
* Returns the this object after filling the section identified by start and end with value
2343+
* Changes all array elements from `start` to `end` index to a static `value` and returns the modified array
23442344
* @param value value to fill array section with
23452345
* @param start index to start filling the array at. If start is negative, it is treated as
23462346
* length+start where length is the length of the array.
@@ -2621,7 +2621,7 @@ interface Int16Array {
26212621
every(predicate: (value: number, index: number, array: Int16Array) => unknown, thisArg?: any): boolean;
26222622

26232623
/**
2624-
* Returns the this object after filling the section identified by start and end with value
2624+
* Changes all array elements from `start` to `end` index to a static `value` and returns the modified array
26252625
* @param value value to fill array section with
26262626
* @param start index to start filling the array at. If start is negative, it is treated as
26272627
* length+start where length is the length of the array.
@@ -2903,7 +2903,7 @@ interface Uint16Array {
29032903
every(predicate: (value: number, index: number, array: Uint16Array) => unknown, thisArg?: any): boolean;
29042904

29052905
/**
2906-
* Returns the this object after filling the section identified by start and end with value
2906+
* Changes all array elements from `start` to `end` index to a static `value` and returns the modified array
29072907
* @param value value to fill array section with
29082908
* @param start index to start filling the array at. If start is negative, it is treated as
29092909
* length+start where length is the length of the array.
@@ -3185,7 +3185,7 @@ interface Int32Array {
31853185
every(predicate: (value: number, index: number, array: Int32Array) => unknown, thisArg?: any): boolean;
31863186

31873187
/**
3188-
* Returns the this object after filling the section identified by start and end with value
3188+
* Changes all array elements from `start` to `end` index to a static `value` and returns the modified array
31893189
* @param value value to fill array section with
31903190
* @param start index to start filling the array at. If start is negative, it is treated as
31913191
* length+start where length is the length of the array.
@@ -3467,7 +3467,7 @@ interface Uint32Array {
34673467
every(predicate: (value: number, index: number, array: Uint32Array) => unknown, thisArg?: any): boolean;
34683468

34693469
/**
3470-
* Returns the this object after filling the section identified by start and end with value
3470+
* Changes all array elements from `start` to `end` index to a static `value` and returns the modified array
34713471
* @param value value to fill array section with
34723472
* @param start index to start filling the array at. If start is negative, it is treated as
34733473
* length+start where length is the length of the array.
@@ -3748,7 +3748,7 @@ interface Float32Array {
37483748
every(predicate: (value: number, index: number, array: Float32Array) => unknown, thisArg?: any): boolean;
37493749

37503750
/**
3751-
* Returns the this object after filling the section identified by start and end with value
3751+
* Changes all array elements from `start` to `end` index to a static `value` and returns the modified array
37523752
* @param value value to fill array section with
37533753
* @param start index to start filling the array at. If start is negative, it is treated as
37543754
* length+start where length is the length of the array.
@@ -4031,7 +4031,7 @@ interface Float64Array {
40314031
every(predicate: (value: number, index: number, array: Float64Array) => unknown, thisArg?: any): boolean;
40324032

40334033
/**
4034-
* Returns the this object after filling the section identified by start and end with value
4034+
* Changes all array elements from `start` to `end` index to a static `value` and returns the modified array
40354035
* @param value value to fill array section with
40364036
* @param start index to start filling the array at. If start is negative, it is treated as
40374037
* length+start where length is the length of the array.

0 commit comments

Comments
 (0)