From 811b1f696d37df72ceba3038949934be0691345d Mon Sep 17 00:00:00 2001 From: Sang <11912225+hantatsang@users.noreply.github.com> Date: Wed, 19 May 2021 10:25:38 +1000 Subject: [PATCH] improve jsdoc for array fill methods (#43627) --- src/lib/es2015.core.d.ts | 2 +- src/lib/es2020.bigint.d.ts | 4 ++-- src/lib/es5.d.ts | 18 +++++++++--------- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/src/lib/es2015.core.d.ts b/src/lib/es2015.core.d.ts index 536f04957b9..c39c6fa6f92 100644 --- a/src/lib/es2015.core.d.ts +++ b/src/lib/es2015.core.d.ts @@ -23,7 +23,7 @@ interface Array { findIndex(predicate: (value: T, index: number, obj: T[]) => unknown, thisArg?: any): number; /** - * Returns the this object after filling the section identified by start and end with value + * Changes all array elements from `start` to `end` index to a static `value` and returns the modified array * @param value value to fill array section with * @param start index to start filling the array at. If start is negative, it is treated as * length+start where length is the length of the array. diff --git a/src/lib/es2020.bigint.d.ts b/src/lib/es2020.bigint.d.ts index 31844087eb4..659fa1a4287 100644 --- a/src/lib/es2020.bigint.d.ts +++ b/src/lib/es2020.bigint.d.ts @@ -164,7 +164,7 @@ interface BigInt64Array { every(predicate: (value: bigint, index: number, array: BigInt64Array) => boolean, thisArg?: any): boolean; /** - * Returns the this object after filling the section identified by start and end with value + * Changes all array elements from `start` to `end` index to a static `value` and returns the modified array * @param value value to fill array section with * @param start index to start filling the array at. If start is negative, it is treated as * length+start where length is the length of the array. @@ -436,7 +436,7 @@ interface BigUint64Array { every(predicate: (value: bigint, index: number, array: BigUint64Array) => boolean, thisArg?: any): boolean; /** - * Returns the this object after filling the section identified by start and end with value + * Changes all array elements from `start` to `end` index to a static `value` and returns the modified array * @param value value to fill array section with * @param start index to start filling the array at. If start is negative, it is treated as * length+start where length is the length of the array. diff --git a/src/lib/es5.d.ts b/src/lib/es5.d.ts index bfa5241a84d..461d9897773 100644 --- a/src/lib/es5.d.ts +++ b/src/lib/es5.d.ts @@ -1776,7 +1776,7 @@ interface Int8Array { every(predicate: (value: number, index: number, array: Int8Array) => unknown, thisArg?: any): boolean; /** - * Returns the this object after filling the section identified by start and end with value + * Changes all array elements from `start` to `end` index to a static `value` and returns the modified array * @param value value to fill array section with * @param start index to start filling the array at. If start is negative, it is treated as * length+start where length is the length of the array. @@ -2058,7 +2058,7 @@ interface Uint8Array { every(predicate: (value: number, index: number, array: Uint8Array) => unknown, thisArg?: any): boolean; /** - * Returns the this object after filling the section identified by start and end with value + * Changes all array elements from `start` to `end` index to a static `value` and returns the modified array * @param value value to fill array section with * @param start index to start filling the array at. If start is negative, it is treated as * length+start where length is the length of the array. @@ -2340,7 +2340,7 @@ interface Uint8ClampedArray { every(predicate: (value: number, index: number, array: Uint8ClampedArray) => unknown, thisArg?: any): boolean; /** - * Returns the this object after filling the section identified by start and end with value + * Changes all array elements from `start` to `end` index to a static `value` and returns the modified array * @param value value to fill array section with * @param start index to start filling the array at. If start is negative, it is treated as * length+start where length is the length of the array. @@ -2621,7 +2621,7 @@ interface Int16Array { every(predicate: (value: number, index: number, array: Int16Array) => unknown, thisArg?: any): boolean; /** - * Returns the this object after filling the section identified by start and end with value + * Changes all array elements from `start` to `end` index to a static `value` and returns the modified array * @param value value to fill array section with * @param start index to start filling the array at. If start is negative, it is treated as * length+start where length is the length of the array. @@ -2903,7 +2903,7 @@ interface Uint16Array { every(predicate: (value: number, index: number, array: Uint16Array) => unknown, thisArg?: any): boolean; /** - * Returns the this object after filling the section identified by start and end with value + * Changes all array elements from `start` to `end` index to a static `value` and returns the modified array * @param value value to fill array section with * @param start index to start filling the array at. If start is negative, it is treated as * length+start where length is the length of the array. @@ -3185,7 +3185,7 @@ interface Int32Array { every(predicate: (value: number, index: number, array: Int32Array) => unknown, thisArg?: any): boolean; /** - * Returns the this object after filling the section identified by start and end with value + * Changes all array elements from `start` to `end` index to a static `value` and returns the modified array * @param value value to fill array section with * @param start index to start filling the array at. If start is negative, it is treated as * length+start where length is the length of the array. @@ -3467,7 +3467,7 @@ interface Uint32Array { every(predicate: (value: number, index: number, array: Uint32Array) => unknown, thisArg?: any): boolean; /** - * Returns the this object after filling the section identified by start and end with value + * Changes all array elements from `start` to `end` index to a static `value` and returns the modified array * @param value value to fill array section with * @param start index to start filling the array at. If start is negative, it is treated as * length+start where length is the length of the array. @@ -3748,7 +3748,7 @@ interface Float32Array { every(predicate: (value: number, index: number, array: Float32Array) => unknown, thisArg?: any): boolean; /** - * Returns the this object after filling the section identified by start and end with value + * Changes all array elements from `start` to `end` index to a static `value` and returns the modified array * @param value value to fill array section with * @param start index to start filling the array at. If start is negative, it is treated as * length+start where length is the length of the array. @@ -4031,7 +4031,7 @@ interface Float64Array { every(predicate: (value: number, index: number, array: Float64Array) => unknown, thisArg?: any): boolean; /** - * Returns the this object after filling the section identified by start and end with value + * Changes all array elements from `start` to `end` index to a static `value` and returns the modified array * @param value value to fill array section with * @param start index to start filling the array at. If start is negative, it is treated as * length+start where length is the length of the array.