mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-10-08 15:54:33 +00:00
425 lines
16 KiB
TypeScript
425 lines
16 KiB
TypeScript
/*
|
|
* Copyright (c) 2021-2022 Huawei Device Co., Ltd.
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
/**
|
|
* PlainArray stores key-value (KV) pairs. Each key must be unique, be of the number type, and have only one value.
|
|
* PlainArray is based on generics and uses a lightweight structure.
|
|
*
|
|
* @namespace PlainArray
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* PlainArray stores key-value (KV) pairs. Each key must be unique, be of the number type, and have only one value.
|
|
* PlainArray is based on generics and uses a lightweight structure.
|
|
*
|
|
* @namespace PlainArray
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
declare class PlainArray<T> {
|
|
/**
|
|
* A constructor used to create a PlainArray object.
|
|
*
|
|
* @throws { BusinessError } 10200012 - The PlainArray's constructor cannot be directly invoked.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* A constructor used to create a PlainArray object.
|
|
*
|
|
* @throws { BusinessError } 10200012 - The PlainArray's constructor cannot be directly invoked.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
constructor();
|
|
/**
|
|
* Gets the element number of the PlainArray.
|
|
*
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* Gets the element number of the PlainArray.
|
|
*
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
length: number;
|
|
/**
|
|
* Appends a key-value pair to PlainArray
|
|
*
|
|
* @param { number } key - key key Added the key of key-value
|
|
* @param { T } value - value value Added the value of key-value
|
|
* @throws { BusinessError } 10200011 - The add method cannot be bound.
|
|
* @throws { BusinessError } 401 - The type of parameters are invalid.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* Appends a key-value pair to PlainArray
|
|
*
|
|
* @param { number } key - key key Added the key of key-value
|
|
* @param { T } value - value value Added the value of key-value
|
|
* @throws { BusinessError } 10200011 - The add method cannot be bound.
|
|
* @throws { BusinessError } 401 - The type of parameters are invalid.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
add(key: number, value: T): void;
|
|
/**
|
|
* Clears the current PlainArray object
|
|
*
|
|
* @throws { BusinessError } 10200011 - The clear method cannot be bound.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* Clears the current PlainArray object
|
|
*
|
|
* @throws { BusinessError } 10200011 - The clear method cannot be bound.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
clear(): void;
|
|
/**
|
|
* Obtains a clone of the current PlainArray object
|
|
*
|
|
* @returns { PlainArray<T> }
|
|
* @throws { BusinessError } 10200011 - The clone method cannot be bound.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* Obtains a clone of the current PlainArray object
|
|
*
|
|
* @returns { PlainArray<T> }
|
|
* @throws { BusinessError } 10200011 - The clone method cannot be bound.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
clone(): PlainArray<T>;
|
|
/**
|
|
* Checks whether the current PlainArray object contains the specified key
|
|
*
|
|
* @param { number } key - key key need to determine whether to include the key
|
|
* @returns { boolean } the boolean type
|
|
* @throws { BusinessError } 10200011 - The has method cannot be bound.
|
|
* @throws { BusinessError } 401 - The type of parameters are invalid.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* Checks whether the current PlainArray object contains the specified key
|
|
*
|
|
* @param { number } key - key key need to determine whether to include the key
|
|
* @returns { boolean } the boolean type
|
|
* @throws { BusinessError } 10200011 - The has method cannot be bound.
|
|
* @throws { BusinessError } 401 - The type of parameters are invalid.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
has(key: number): boolean;
|
|
/**
|
|
* Queries the value associated with the specified key
|
|
*
|
|
* @param { number } key - key key Looking for goals
|
|
* @returns { T } the value of key-value pairs
|
|
* @throws { BusinessError } 10200011 - The get method cannot be bound.
|
|
* @throws { BusinessError } 401 - The type of parameters are invalid.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* Queries the value associated with the specified key
|
|
*
|
|
* @param { number } key - key key Looking for goals
|
|
* @returns { T } the value of key-value pairs
|
|
* @throws { BusinessError } 10200011 - The get method cannot be bound.
|
|
* @throws { BusinessError } 401 - The type of parameters are invalid.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
get(key: number): T;
|
|
/**
|
|
* Queries the index for a specified key
|
|
*
|
|
* @param { number } key - key key Looking for goals
|
|
* @returns { number } Subscript corresponding to target
|
|
* @throws { BusinessError } 10200011 - The getIndexOfKey method cannot be bound.
|
|
* @throws { BusinessError } 401 - The type of parameters are invalid.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* Queries the index for a specified key
|
|
*
|
|
* @param { number } key - key key Looking for goals
|
|
* @returns { number } Subscript corresponding to target
|
|
* @throws { BusinessError } 10200011 - The getIndexOfKey method cannot be bound.
|
|
* @throws { BusinessError } 401 - The type of parameters are invalid.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
getIndexOfKey(key: number): number;
|
|
/**
|
|
* Queries the index for a specified value
|
|
*
|
|
* @param { T } value - value value Looking for goals
|
|
* @returns { number } Subscript corresponding to target
|
|
* @throws { BusinessError } 10200011 - The getIndexOfValue method cannot be bound.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* Queries the index for a specified value
|
|
*
|
|
* @param { T } value - value value Looking for goals
|
|
* @returns { number } Subscript corresponding to target
|
|
* @throws { BusinessError } 10200011 - The getIndexOfValue method cannot be bound.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
getIndexOfValue(value: T): number;
|
|
/**
|
|
* Checks whether the current PlainArray object is empty
|
|
*
|
|
* @returns { boolean } the boolean type
|
|
* @throws { BusinessError } 10200011 - The isEmpty method cannot be bound.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* Checks whether the current PlainArray object is empty
|
|
*
|
|
* @returns { boolean } the boolean type
|
|
* @throws { BusinessError } 10200011 - The isEmpty method cannot be bound.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
isEmpty(): boolean;
|
|
/**
|
|
* Queries the key at a specified index
|
|
*
|
|
* @param { number } index - index index Target subscript for search
|
|
* @returns { number } the key of key-value pairs
|
|
* @throws { BusinessError } 10200011 - The getKeyAt method cannot be bound.
|
|
* @throws { BusinessError } 401 - The type of parameters are invalid.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* Queries the key at a specified index
|
|
*
|
|
* @param { number } index - index index Target subscript for search
|
|
* @returns { number } the key of key-value pairs
|
|
* @throws { BusinessError } 10200011 - The getKeyAt method cannot be bound.
|
|
* @throws { BusinessError } 401 - The type of parameters are invalid.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
getKeyAt(index: number): number;
|
|
/**
|
|
* Remove the key-value pair based on a specified key if it exists and return the value
|
|
*
|
|
* @param { number } key - key key Target to be deleted
|
|
* @returns { T } Target mapped value
|
|
* @throws { BusinessError } 10200011 - The remove method cannot be bound.
|
|
* @throws { BusinessError } 401 - The type of parameters are invalid.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* Remove the key-value pair based on a specified key if it exists and return the value
|
|
*
|
|
* @param { number } key - key key Target to be deleted
|
|
* @returns { T } Target mapped value
|
|
* @throws { BusinessError } 10200011 - The remove method cannot be bound.
|
|
* @throws { BusinessError } 401 - The type of parameters are invalid.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
remove(key: number): T;
|
|
/**
|
|
* Remove the key-value pair at a specified index if it exists and return the value
|
|
*
|
|
* @param { number } index - index index Target subscript for search
|
|
* @returns { T } the T type
|
|
* @throws { BusinessError } 10200011 - The removeAt method cannot be bound.
|
|
* @throws { BusinessError } 401 - The type of parameters are invalid.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* Remove the key-value pair at a specified index if it exists and return the value
|
|
*
|
|
* @param { number } index - index index Target subscript for search
|
|
* @returns { T } the T type
|
|
* @throws { BusinessError } 10200011 - The removeAt method cannot be bound.
|
|
* @throws { BusinessError } 401 - The type of parameters are invalid.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
removeAt(index: number): T;
|
|
/**
|
|
* Remove a group of key-value pairs from a specified index
|
|
*
|
|
* @param { number } index - index index remove start index
|
|
* @param { number } size - size size Expected deletion quantity
|
|
* @returns { number } Actual deleted quantity
|
|
* @throws { BusinessError } 10200011 - The removeRangeFrom method cannot be bound.
|
|
* @throws { BusinessError } 10200001 - The value of index is out of range.
|
|
* @throws { BusinessError } 401 - The type of parameters are invalid.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* Remove a group of key-value pairs from a specified index
|
|
*
|
|
* @param { number } index - index index remove start index
|
|
* @param { number } size - size size Expected deletion quantity
|
|
* @returns { number } Actual deleted quantity
|
|
* @throws { BusinessError } 10200011 - The removeRangeFrom method cannot be bound.
|
|
* @throws { BusinessError } 10200001 - The value of index is out of range.
|
|
* @throws { BusinessError } 401 - The type of parameters are invalid.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
removeRangeFrom(index: number, size: number): number;
|
|
/**
|
|
* Update value on specified index
|
|
*
|
|
* @param { number } index - index index Target subscript for search
|
|
* @param { T } value - value value Updated the target mapped value
|
|
* @throws { BusinessError } 10200011 - The setValueAt method cannot be bound.
|
|
* @throws { BusinessError } 10200001 - The value of index is out of range.
|
|
* @throws { BusinessError } 401 - The type of parameters are invalid.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* Update value on specified index
|
|
*
|
|
* @param { number } index - index index Target subscript for search
|
|
* @param { T } value - value value Updated the target mapped value
|
|
* @throws { BusinessError } 10200011 - The setValueAt method cannot be bound.
|
|
* @throws { BusinessError } 10200001 - The value of index is out of range.
|
|
* @throws { BusinessError } 401 - The type of parameters are invalid.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
setValueAt(index: number, value: T): void;
|
|
/**
|
|
* Obtains the string representation of the PlainArray object
|
|
*
|
|
* @returns { String }
|
|
* @throws { BusinessError } 10200011 - The toString method cannot be bound.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* Obtains the string representation of the PlainArray object
|
|
*
|
|
* @returns { String }
|
|
* @throws { BusinessError } 10200011 - The toString method cannot be bound.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
toString(): String;
|
|
/**
|
|
* Queries the value at a specified index
|
|
*
|
|
* @param { number } index - index index Target subscript for search
|
|
* @returns { T } the value of key-value pairs
|
|
* @throws { BusinessError } 10200011 - The getValueAt method cannot be bound.
|
|
* @throws { BusinessError } 10200001 - The value of index is out of range.
|
|
* @throws { BusinessError } 401 - The type of parameters are invalid.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* Queries the value at a specified index
|
|
*
|
|
* @param { number } index - index index Target subscript for search
|
|
* @returns { T } the value of key-value pairs
|
|
* @throws { BusinessError } 10200011 - The getValueAt method cannot be bound.
|
|
* @throws { BusinessError } 10200001 - The value of index is out of range.
|
|
* @throws { BusinessError } 401 - The type of parameters are invalid.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
getValueAt(index: number): T;
|
|
/**
|
|
* Executes a provided function once for each value in the PlainArray object.
|
|
*
|
|
* @param { (value: T, index?: number, PlainArray?: PlainArray<T>) => void } callbackFn - callbackFn callbackFn
|
|
* @param { Object } thisArg - thisArg thisArg
|
|
* @throws { BusinessError } 10200011 - The forEach method cannot be bound.
|
|
* @throws { BusinessError } 401 - The type of parameters are invalid.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* Executes a provided function once for each value in the PlainArray object.
|
|
*
|
|
* @param { (value: T, index?: number, PlainArray?: PlainArray<T>) => void } callbackFn - callbackFn callbackFn
|
|
* @param { Object } thisArg - thisArg thisArg
|
|
* @throws { BusinessError } 10200011 - The forEach method cannot be bound.
|
|
* @throws { BusinessError } 401 - The type of parameters are invalid.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
forEach(callbackFn: (value: T, index?: number, PlainArray?: PlainArray<T>) => void, thisArg?: Object): void;
|
|
/**
|
|
* returns an iterator.Each item of the iterator is a Javascript Object
|
|
*
|
|
* @returns { IterableIterator<[number, T]> }
|
|
* @throws { BusinessError } 10200011 - The Symbol.iterator method cannot be bound.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* returns an iterator.Each item of the iterator is a Javascript Object
|
|
*
|
|
* @returns { IterableIterator<[number, T]> }
|
|
* @throws { BusinessError } 10200011 - The Symbol.iterator method cannot be bound.
|
|
* @syscap SystemCapability.Utils.Lang
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
[Symbol.iterator](): IterableIterator<[number, T]>;
|
|
}
|
|
|
|
export default PlainArray;
|