diff --git a/src/lib/es5.d.ts b/src/lib/es5.d.ts index 786c953b42c74..fab8fd0da0486 100644 --- a/src/lib/es5.d.ts +++ b/src/lib/es5.d.ts @@ -1375,14 +1375,18 @@ interface Array { /** * Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. * @param start The zero-based location in the array from which to start removing elements. - * @param deleteCount The number of elements to remove. + * @param deleteCount The number of elements to remove. Omitting this argument will remove all elements from the start + * paramater location to end of the array. If value of this argument is either a negative number, zero, undefined, or a type + * that cannot be converted to an integer, the function will evaluate the argument as zero and not remove any elements. * @returns An array containing the elements that were deleted. */ splice(start: number, deleteCount?: number): T[]; /** * Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. * @param start The zero-based location in the array from which to start removing elements. - * @param deleteCount The number of elements to remove. + * @param deleteCount The number of elements to remove. If value of this argument is either a negative number, zero, + * undefined, or a type that cannot be converted to an integer, the function will evaluate the argument as zero and + * not remove any elements. * @param items Elements to insert into the array in place of the deleted elements. * @returns An array containing the elements that were deleted. */ diff --git a/tests/baselines/reference/completionEntryForUnionMethod.baseline b/tests/baselines/reference/completionEntryForUnionMethod.baseline index 4a503b4a10a4c..c0e0ccc7c838d 100644 --- a/tests/baselines/reference/completionEntryForUnionMethod.baseline +++ b/tests/baselines/reference/completionEntryForUnionMethod.baseline @@ -4404,7 +4404,7 @@ "kind": "space" }, { - "text": "The number of elements to remove.", + "text": "The number of elements to remove. Omitting this argument will remove all elements from the start\nparamater location to end of the array. If value of this argument is either a negative number, zero, undefined, or a type\nthat cannot be converted to an integer, the function will evaluate the argument as zero and not remove any elements.", "kind": "text" } ] diff --git a/tests/baselines/reference/goToTypeDefinition_arrayType.baseline.jsonc b/tests/baselines/reference/goToTypeDefinition_arrayType.baseline.jsonc index bb25003a8fc5a..1cd2c60375f26 100644 --- a/tests/baselines/reference/goToTypeDefinition_arrayType.baseline.jsonc +++ b/tests/baselines/reference/goToTypeDefinition_arrayType.baseline.jsonc @@ -87,14 +87,18 @@ // /** // * Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. // * @param start The zero-based location in the array from which to start removing elements. -// * @param deleteCount The number of elements to remove. +// * @param deleteCount The number of elements to remove. Omitting this argument will remove all elements from the start +// * paramater location to end of the array. If value of this argument is either a negative number, zero, undefined, or a type +// * that cannot be converted to an integer, the function will evaluate the argument as zero and not remove any elements. // * @returns An array containing the elements that were deleted. // */ // splice(start: number, deleteCount?: number): T[]; // /** // * Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. // * @param start The zero-based location in the array from which to start removing elements. -// * @param deleteCount The number of elements to remove. +// * @param deleteCount The number of elements to remove. If value of this argument is either a negative number, zero, +// * undefined, or a type that cannot be converted to an integer, the function will evaluate the argument as zero and +// * not remove any elements. // * @param items Elements to insert into the array in place of the deleted elements. // * @returns An array containing the elements that were deleted. // */ @@ -340,14 +344,18 @@ // /** // * Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. // * @param start The zero-based location in the array from which to start removing elements. -// * @param deleteCount The number of elements to remove. +// * @param deleteCount The number of elements to remove. Omitting this argument will remove all elements from the start +// * paramater location to end of the array. If value of this argument is either a negative number, zero, undefined, or a type +// * that cannot be converted to an integer, the function will evaluate the argument as zero and not remove any elements. // * @returns An array containing the elements that were deleted. // */ // splice(start: number, deleteCount?: number): T[]; // /** // * Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. // * @param start The zero-based location in the array from which to start removing elements. -// * @param deleteCount The number of elements to remove. +// * @param deleteCount The number of elements to remove. If value of this argument is either a negative number, zero, +// * undefined, or a type that cannot be converted to an integer, the function will evaluate the argument as zero and +// * not remove any elements. // * @param items Elements to insert into the array in place of the deleted elements. // * @returns An array containing the elements that were deleted. // */