interface_sdk-js/api/@ohos.util.HashSet.d.ts
wangyong ae9de93c60 Add the d.ts description file of the container class
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>
2022-02-14 10:55:54 +08:00

93 lines
2.8 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 HashSet<T> {
/**
* A constructor used to create a HashSet object.
* @since 8
* @syscap SystemCapability.Utils.Lang
*/
constructor();
/**
* Gets the element number of the hashset.
* @since 8
* @syscap SystemCapability.Utils.Lang
*/
length: number;
/**
* Returns whether the Set object contains elements
* @return the boolean type
* @since 8
* @syscap SystemCapability.Utils.Lang
*/
isEmpty(): boolean;
/**
* Returns whether the Set object contain s the elements
* @param value need to determine whether to include the element
* @return the boolean type
* @since 8
* @syscap SystemCapability.Utils.Lang
*/
has(value: T): boolean;
/**
* If the set does not contain the element, the specified element is added
* @param value Added element
* @returns the boolean type(Is there contain this element)
* @since 8
* @syscap SystemCapability.Utils.Lang
*/
add(value: T): boolean;
/**
* Remove a specified element from a Set object
* @param value Target to be deleted
* @return the boolean type(Is there contain this element)
* @since 8
* @syscap SystemCapability.Utils.Lang
*/
remove(value: T): boolean;
/**
* Clears all element groups in a set
* @since 8
* @syscap SystemCapability.Utils.Lang
*/
clear(): void;
/**
* Executes a provided function once for each value in the Set object.
* @since 8
* @syscap SystemCapability.Utils.Lang
*/
forEach(callbackfn: (value?: T, key?: T, set?: HashSet<T>) => void,
thisArg?: Object): void;
/**
* Returns a new Iterator object that contains the values contained in this set
* @since 8
* @syscap SystemCapability.Utils.Lang
*/
values(): IterableIterator<T>;
/**
* Returns a new Iterator object that contains the [key, value] pairs for each element in the Set object in insertion order
* @since 8
* @syscap SystemCapability.Utils.Lang
*/
entries(): IterableIterator<[T, T]>;
/**
* returns an iterator.Each item of the iterator is a Javascript Object
* @since 8
* @syscap SystemCapability.Utils.Lang
*/
[Symbol.iterator](): IterableIterator<T>;
}
export default HashSet;