interface_sdk-js/api/@ohos.util.PlainArray.d.ts

/*
 * 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.
 */

declare class PlainArray<T> {
  /**
   * A constructor used to create a PlainArray object.
   * @throws { BusinessError } 10200012 - The PlainArray's constructor cannot be directly invoked.
   * @crossplatform
   * @since 8
   * @syscap SystemCapability.Utils.Lang
   */
  constructor();
  /**
   * Gets the element number of the PlainArray.
   * @crossplatform
   * @since 8
   * @syscap SystemCapability.Utils.Lang
   */
  length: number;
  /**
   * Appends a key-value pair to PlainArray
   * @param key Added the key of key-value
   * @param 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.
   * @crossplatform
   * @since 8
   * @syscap SystemCapability.Utils.Lang
   */
  add(key: number, value: T): void;
  /**
   * Clears the current PlainArray object
   * @throws { BusinessError } 10200011 - The clear method cannot be bound.
   * @crossplatform
   * @since 8
   * @syscap SystemCapability.Utils.Lang
   */
  clear(): void;
  /**
   * Obtains a clone of the current PlainArray object
   * @throws { BusinessError } 10200011 - The clone method cannot be bound.
   * @crossplatform
   * @since 8
   * @syscap SystemCapability.Utils.Lang
   */
  clone(): PlainArray<T>;
  /**
   * Checks whether the current PlainArray object contains the specified key
   * @param key need to determine whether to include the key
   * @returns the boolean type
   * @throws { BusinessError } 10200011 - The has method cannot be bound.
   * @throws { BusinessError } 401 - The type of parameters are invalid.
   * @crossplatform
   * @since 8
   * @syscap SystemCapability.Utils.Lang
   */
  has(key: number): boolean;
  /**
   * Queries the value associated with the specified key
   * @param key Looking for goals
   * @returns the value of key-value pairs
   * @throws { BusinessError } 10200011 - The get method cannot be bound.
   * @throws { BusinessError } 401 - The type of parameters are invalid.
   * @crossplatform
   * @since 8
   * @syscap SystemCapability.Utils.Lang
   */
  get(key: number): T;
  /**
   * Queries the index for a specified key
   * @param key Looking for goals
   * @returns Subscript corresponding to target
   * @throws { BusinessError } 10200011 - The getIndexOfKey method cannot be bound.
   * @throws { BusinessError } 401 - The type of parameters are invalid.
   * @crossplatform
   * @since 8
   * @syscap SystemCapability.Utils.Lang
   */
  getIndexOfKey(key: number): number;
  /**
    * Queries the index for a specified value
    * @param value Looking for goals
    * @returns Subscript corresponding to target
    * @throws { BusinessError } 10200011 - The getIndexOfValue method cannot be bound.
    * @crossplatform
    * @since 8
    * @syscap SystemCapability.Utils.Lang
    */
  getIndexOfValue(value: T): number;
  /**
   * Checks whether the current PlainArray object is empty
   * @returns the boolean type
   * @throws { BusinessError } 10200011 - The isEmpty method cannot be bound.
   * @crossplatform
   * @since 8
   * @syscap SystemCapability.Utils.Lang
   */
  isEmpty(): boolean;
  /**
   * Queries the key at a specified index
   * @param index Target subscript for search
   * @returns the key of key-value pairs
   * @throws { BusinessError } 10200011 - The getKeyAt method cannot be bound.
   * @throws { BusinessError } 401 - The type of parameters are invalid.
   * @crossplatform
   * @since 8
   * @syscap SystemCapability.Utils.Lang
   */
  getKeyAt(index: number): number;
  /**
   * Remove the key-value pair based on a specified key if it exists and return the value
   * @param key  Target to be deleted
   * @returns Target mapped value
   * @throws { BusinessError } 10200011 - The remove method cannot be bound.
   * @throws { BusinessError } 401 - The type of parameters are invalid.
   * @crossplatform
   * @since 8
   * @syscap SystemCapability.Utils.Lang
   */
  remove(key: number): T;
  /**
   * Remove the key-value pair at a specified index if it exists and return the value
   * @param index  Target subscript for search
   * @returns the T type
   * @throws { BusinessError } 10200011 - The removeAt method cannot be bound.
   * @throws { BusinessError } 401 - The type of parameters are invalid.
   * @crossplatform
   * @since 8
   * @syscap SystemCapability.Utils.Lang
   */
  removeAt(index: number): T;
  /**
   * Remove a group of key-value pairs from a specified index
   * @param index  remove start index
   * @param size Expected deletion quantity
   * @returns 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.
   * @crossplatform
   * @since 8
   * @syscap SystemCapability.Utils.Lang
   */
  removeRangeFrom(index: number, size: number): number;
  /**
   * Update value on specified index
   * @param index Target subscript for search
   * @param 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.
   * @crossplatform
   * @since 8
   * @syscap SystemCapability.Utils.Lang
   */
  setValueAt(index: number, value: T): void;
  /**
   * Obtains the string representation of the PlainArray object
   * @throws { BusinessError } 10200011 - The toString method cannot be bound.
   * @crossplatform
   * @since 8
   * @syscap SystemCapability.Utils.Lang
   */
  toString(): String;
  /**
   * Queries the value at a specified index
   * @param index Target subscript for search
   * @returns 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.
   * @crossplatform
   * @since 8
   * @syscap SystemCapability.Utils.Lang
   */
  getValueAt(index: number): T;
  /**
   * Executes a provided function once for each value in the PlainArray object.
   * @throws { BusinessError } 10200011 - The forEach method cannot be bound.
   * @throws { BusinessError } 401 - The type of parameters are invalid.
   * @crossplatform
   * @since 8
   * @syscap SystemCapability.Utils.Lang
   */
  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
   * @throws { BusinessError } 10200011 - The Symbol.iterator method cannot be bound.
   * @crossplatform
   * @since 8
   * @syscap SystemCapability.Utils.Lang
   */
  [Symbol.iterator](): IterableIterator<[number, T]>;
}

export default PlainArray;