mirror of
https://github.com/cocos/cocos4.git
synced 2026-11-20 23:52:40 +08:00
509d73b27d
* PR1: add explicit function return type (#15311) * PR4: add explicit function return type (#15314) * [ci skip][AUTO]: Automated code generating update: 8843bfe54cd3f8e6f84432948716c8d130ecb233 (#15314) (#15357) Co-authored-by: cocos-robot <cocos-robot@cocos.com> * add function return type * fix version checking * fix return type --------- Co-authored-by: Cocos Robot <48829427+cocos-robot@users.noreply.github.com> Co-authored-by: cocos-robot <cocos-robot@cocos.com>
197 lines
7.0 KiB
TypeScript
197 lines
7.0 KiB
TypeScript
/*
|
|
Copyright (c) 2018-2023 Xiamen Yaji Software Co., Ltd.
|
|
|
|
https://www.cocos.com/
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
in the Software without restriction, including without limitation the rights to
|
|
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
|
of the Software, and to permit persons to whom the Software is furnished to do so,
|
|
subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
all copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
THE SOFTWARE.
|
|
*/
|
|
|
|
import { logID } from '../platform/debug';
|
|
|
|
export { default as MutableForwardIterator } from './mutable-forward-iterator';
|
|
|
|
/**
|
|
* @zh
|
|
* 移除指定索引的数组元素。
|
|
* @en
|
|
* Removes the array item at the specified index.
|
|
* @param array @zh 被操作的数组。@en The array to be operated.
|
|
* @param index @zh 待移除元素的索引。@en The index of the element to be removed.
|
|
*/
|
|
export function removeAt<T> (array: T[], index: number): void {
|
|
array.splice(index, 1);
|
|
}
|
|
|
|
/**
|
|
* @zh
|
|
* 移除指定索引的数组元素。
|
|
* 此函数十分高效,但会改变数组的元素次序。
|
|
* @en
|
|
* Removes the array item at the specified index.
|
|
* It's faster but the order of the array will be changed.
|
|
* @param array @zh 被操作的数组。@en The array to be operated.
|
|
* @param index @zh 待移除元素的索引。@en The index of the element to be removed.
|
|
*/
|
|
export function fastRemoveAt<T> (array: T[], index: number): void {
|
|
const length = array.length;
|
|
if (index < 0 || index >= length) {
|
|
return;
|
|
}
|
|
array[index] = array[length - 1];
|
|
array.length = length - 1;
|
|
}
|
|
|
|
/**
|
|
* @zh
|
|
* 移除首个指定的数组元素。判定元素相等时相当于于使用了 `Array.prototype.indexOf`。
|
|
* @en
|
|
* Removes the first occurrence of a specific object from the array.
|
|
* Decision of the equality of elements is similar to `Array.prototype.indexOf`.
|
|
* @param array @zh 被操作的数组。@en The array to be operated.
|
|
* @param value @zh 待移除元素。@en The value to be removed.
|
|
*/
|
|
export function remove<T> (array: T[], value: T): boolean {
|
|
const index = array.indexOf(value);
|
|
if (index >= 0) {
|
|
removeAt(array, index);
|
|
return true;
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @zh
|
|
* 移除首个指定的数组元素。判定元素相等时相当于于使用了 `Array.prototype.indexOf`。
|
|
* 此函数十分高效,但会改变数组的元素次序。
|
|
* @en
|
|
* Removes the first occurrence of a specific object from the array.
|
|
* Decision of the equality of elements is similar to `Array.prototype.indexOf`.
|
|
* It's faster but the order of the array will be changed.
|
|
* @param array @zh 被操作的数组。@en The array to be operated.
|
|
* @param value @zh 待移除元素。@en The value to be removed.
|
|
*/
|
|
export function fastRemove<T> (array: T[], value: T): void {
|
|
const index = array.indexOf(value);
|
|
if (index >= 0) {
|
|
array[index] = array[array.length - 1];
|
|
--array.length;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @zh
|
|
* 移除首个使谓词满足的数组元素。
|
|
* @en
|
|
* Removes the first occurrence of a specific object from the array where `predicate` is `true`.
|
|
* @param array @zh 被操作的数组。@en The array to be operated.
|
|
* @param predicate @zh 一元谓词,如果要元素的话,需要返回 true。@en unary predicate which returns true if the element should be removed.
|
|
*/
|
|
export function removeIf<T> (array: T[], predicate: (value: T) => boolean): T | undefined {
|
|
const index = array.findIndex(predicate);
|
|
if (index >= 0) {
|
|
const value = array[index];
|
|
removeAt(array, index);
|
|
return value;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @zh
|
|
* 验证数组的类型。
|
|
* 此函数将用 `instanceof` 操作符验证每一个元素。
|
|
* @en
|
|
* Verify array's Type.
|
|
* This function tests each element using `instanceof` operator.
|
|
* @param array @zh 待验证的数组。@en The array to be verified.
|
|
* @param type @zh 用来判断数组元素的数据类型。@en The type used to verify the element type.
|
|
* @returns @zh 当每一个元素都是指定类型时返回 `true`,否则返回 `false`。@en Return true if all elements of the array is the same type, false others.
|
|
*/
|
|
export function verifyType<T extends Function> (array: any[], type: T): array is T[] {
|
|
if (array && array.length > 0) {
|
|
for (const item of array) {
|
|
if (!(item instanceof type)) {
|
|
logID(1300);
|
|
return false;
|
|
}
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @zh
|
|
* 移除多个数组元素。
|
|
* @en
|
|
* Removes multiple array elements.
|
|
* @param array @zh 被操作的数组。@en The array to be operated.
|
|
* @param removals @zh 所有待移除的元素。此数组的每个元素所对应的首个源数组的元素都会被移除。
|
|
* @en The values to be removed. If a value appears multiple times in the array, only the first math element will be removed.
|
|
*/
|
|
export function removeArray<T> (array: T[], removals: T[]): void {
|
|
for (let i = 0, l = removals.length; i < l; i++) {
|
|
remove(array, removals[i]);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @zh
|
|
* 在数组的指定索引上插入对象。
|
|
* @en
|
|
* Inserts some objects at specified index.
|
|
* @param array @zh 被操作的数组。@en The array to be operated.
|
|
* @param objects @zh 插入的所有对象。@en The objects to be inserted.
|
|
* @param index @zh 插入的索引。@en The index to insert at.
|
|
* @returns @zh 传入的 `array`。@en The passed in `array`.
|
|
*/
|
|
export function appendObjectsAt<T> (array: T[], objects: T[], index: number): T[] {
|
|
array.splice.apply(array, [index, 0, ...objects]);
|
|
return array;
|
|
}
|
|
|
|
/**
|
|
* @zh
|
|
* 返回数组是否包含指定的元素。
|
|
* @en
|
|
* Determines whether the array contains a specific element.
|
|
* @param array @zh 被查询的数组 @en The array to be checked.
|
|
* @param value @zh 用来查询的值 @en The value used to check for.
|
|
* @returns @zh true 如果包含该元素,否则返回 false。@en true if contains the value, false else.
|
|
*/
|
|
export function contains<T> (array: T[], value: T): boolean {
|
|
return array.indexOf(value) >= 0;
|
|
}
|
|
|
|
/**
|
|
* @zh
|
|
* 拷贝数组。
|
|
* @en
|
|
* Copy an array.
|
|
* @param array @zh 用来拷贝的数组。@en The array to be copied from.
|
|
* @returns @zh 数组的副本。@en A new array has the same values as `array`.
|
|
*/
|
|
export function copy<T> (array: T[]): T[] {
|
|
const len = array.length;
|
|
const cloned = new Array<T>(len);
|
|
for (let i = 0; i < len; i += 1) {
|
|
cloned[i] = array[i];
|
|
}
|
|
return cloned;
|
|
}
|