mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-12-04 05:32:31 +00:00
ae9de93c60
Description
Description of the container class interface, description
of related parameters, and detailed version information.
Changed the previous import method, improved the efficiency,
and added the description of @syscap
Related issue
#I4RO5E:Add the d.ts file of the container class
Signed-off-by: wangyong <wangyong237@huawei.com>
102 lines
3.4 KiB
TypeScript
102 lines
3.4 KiB
TypeScript
/*
|
|
* Copyright (c) 2021 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 Deque<T> {
|
|
/**
|
|
* A constructor used to create a Deque object.
|
|
* @since 8
|
|
* @syscap SystemCapability.Utils.Lang
|
|
*/
|
|
constructor();
|
|
/**
|
|
* Gets the element number of the Deque.This is a number one higher than the highest index in the deque.
|
|
* @since 8
|
|
* @syscap SystemCapability.Utils.Lang
|
|
*/
|
|
length: number;
|
|
/**
|
|
* Inserts an element into the deque header.
|
|
* @param element to be appended to this deque
|
|
* @since 8
|
|
* @syscap SystemCapability.Utils.Lang
|
|
*/
|
|
insertFront(element: T): void;
|
|
/**
|
|
* Inserting an element at the end of a deque
|
|
* @param element to be appended to this deque
|
|
* @since 8
|
|
* @syscap SystemCapability.Utils.Lang
|
|
*/
|
|
insertEnd(element: T): void;
|
|
/**
|
|
* Check if deque contains the specified element
|
|
* @param element element to be contained
|
|
* @return the boolean type,if deque contains the specified element,return true,else return false
|
|
* @since 8
|
|
* @syscap SystemCapability.Utils.Lang
|
|
*/
|
|
has(element: T): boolean;
|
|
/**
|
|
* Obtains the header element of a deque.
|
|
* @return the T type
|
|
* @since 8
|
|
* @syscap SystemCapability.Utils.Lang
|
|
*/
|
|
getFirst(): T;
|
|
/**
|
|
* Obtains the end element of a deque.
|
|
* @return the T type
|
|
* @throws an exception if the queue is empty
|
|
* @since 8
|
|
* @syscap SystemCapability.Utils.Lang
|
|
*/
|
|
getLast(): T;
|
|
/**
|
|
* Obtains the header element of a deque and delete the element.
|
|
* @return the T type
|
|
* @throws an exception if the deque is empty
|
|
* @since 8
|
|
* @syscap SystemCapability.Utils.Lang
|
|
*/
|
|
popFirst(): T;
|
|
/**
|
|
* Obtains the end element of a deque and delete the element.
|
|
* @return the T type
|
|
* @throws an exception if the deque is empty
|
|
* @since 8
|
|
* @syscap SystemCapability.Utils.Lang
|
|
*/
|
|
popLast(): T;
|
|
/**
|
|
* Executes a provided function once for each value in the deque object.
|
|
* @param callbackfn (required) A function that accepts up to four arguments.The function to be called for each element in the deque
|
|
* @param Value (required) current element
|
|
* @param Index (Optional) The index value of the current element.
|
|
* @param deque (Optional) The deque object to which the current element belongs.
|
|
* @param thisArg (Optional) The value passed to the function generally uses the "this" value.
|
|
* If this parameter is empty, "undefined" will be passed to the "this" value
|
|
* @since 8
|
|
* @syscap SystemCapability.Utils.Lang
|
|
*/
|
|
forEach(callbackfn: (value: T, index?: number, deque?: Deque<T>) => void,
|
|
thisArg?: Object): void;
|
|
/**
|
|
* returns an iterator.Each item of the iterator is a Javascript Object
|
|
* @since 8
|
|
* @syscap SystemCapability.Utils.Lang
|
|
*/
|
|
[Symbol.iterator](): IterableIterator<T>;
|
|
}
|
|
|
|
export default Deque; |