HarmonyOS API:@ohos.util (util工具函数)

joytrian
发布于 2023-4-11 17:35
浏览
0收藏

版本:v3.1 Beta

@ohos.util (util工具函数)

isSharedArrayBuffer8+

isSharedArrayBuffer(value: Object): boolean

检查输入的value是否是SharedArrayBuffer类型。

系统能力: SystemCapability.Utils.Lang

参数:

参数名

类型

必填

说明

value

Object

待检测对象。

返回值:

类型

说明

boolean

判断的结果,如果是内置包含的SharedArrayBuffer类型为true,反之为false。

示例:

let that = new util.types();
let result = that.isSharedArrayBuffer(new SharedArrayBuffer(0));

LruBuffer(deprecated)

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​LRUCache9+​替代。

属性

系统能力: 以下各项对应的系统能力均为SystemCapability.Utils.Lang。

名称

类型

可读

可写

说明

length

number

当前缓冲区中值的总数。

示例:

let pro = new util.LruBuffer();
pro.put(2,10);
pro.put(1,8);
let result = pro.length;

constructor(deprecated)

constructor(capacity?: number)

默认构造函数用于创建一个新的LruBuffer实例,默认容量为64。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​LRUCache.constructor9+​替代。

系统能力: SystemCapability.Utils.Lang

参数:

参数名

类型

必填

说明

capacity

number

指示要为缓冲区自定义的容量。

示例:

let lrubuffer= new util.LruBuffer();

updateCapacity(deprecated)

updateCapacity(newCapacity: number): void

将缓冲区容量更新为指定容量,如果newCapacity小于或等于0,则抛出异常。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​LRUCache.updateCapacity9+​替代。

系统能力: SystemCapability.Utils.Lang

参数:

参数名

类型

必填

说明

newCapacity

number

指示要为缓冲区自定义的容量。

示例:

let pro = new util.LruBuffer();
let result = pro.updateCapacity(100);

toString(deprecated)

toString(): string

返回对象的字符串表示形式。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​LRUCache.toString9+​替代。

系统能力: SystemCapability.Utils.Lang

返回值:

类型

说明

string

返回对象的字符串表示形式。

示例:

let pro = new util.LruBuffer();
pro.put(2,10);
pro.get(2);
pro.remove(20);
let result = pro.toString();

getCapacity(deprecated)

getCapacity(): number

获取当前缓冲区的容量。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​LRUCache.getCapacity9+​替代。

系统能力: SystemCapability.Utils.Lang

返回值:

类型

说明

number

返回当前缓冲区的容量。

示例:

let pro = new util.LruBuffer();
let result = pro.getCapacity();

clear(deprecated)

clear(): void

从当前缓冲区清除键值对。后续会调用afterRemoval()方法执行后续操作。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​LRUCache.clear9+​替代。

系统能力: SystemCapability.Utils.Lang

示例:

let pro = new util.LruBuffer();
pro.put(2,10);
let result = pro.length;
pro.clear();

getCreateCount(deprecated)

getCreateCount(): number

获取createDefault()返回值的次数。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​LRUCache.getCreateCount9+​替代。

系统能力: SystemCapability.Utils.Lang

返回值:

类型

说明

number

返回createDefault()返回值的次数。

示例:

let pro = new util.LruBuffer();
pro.put(1,8);
let result = pro.getCreateCount();

getMissCount(deprecated)

getMissCount(): number

获取查询值不匹配的次数。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​LRUCache.getMissCount9+​替代。

系统能力: SystemCapability.Utils.Lang

返回值:

类型

说明

number

返回查询值不匹配的次数。

示例:

let pro = new util.LruBuffer();
pro.put(2,10);
pro.get(2);
let result = pro.getMissCount();

getRemovalCount(deprecated)

getRemovalCount(): number

获取从缓冲区中逐出值的次数。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​LRUCache.getRemovalCount9+​替代。

系统能力: SystemCapability.Utils.Lang

返回值:

类型

说明

number

返回从缓冲区中驱逐的次数。

示例:

let pro = new util.LruBuffer();
pro.put(2,10);
pro.updateCapacity(2);
pro.put(50,22);
let result = pro.getRemovalCount();

getMatchCount(deprecated)

getMatchCount(): number

获取查询值匹配成功的次数。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​LRUCache.getMatchCount9+​替代。

系统能力: SystemCapability.Utils.Lang

返回值:

类型

说明

number

返回查询值匹配成功的次数。

示例:

let pro = new util.LruBuffer();
pro.put(2,10);
pro.get(2);
let result = pro.getMatchCount();

getPutCount(deprecated)

getPutCount(): number

获取将值添加到缓冲区的次数。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​LRUCache.getPutCount9+​替代。

系统能力: SystemCapability.Utils.Lang

返回值:

类型

说明

number

返回将值添加到缓冲区的次数。

示例:

let pro = new util.LruBuffer();
pro.put(2,10);
let result = pro.getPutCount();

isEmpty(deprecated)

isEmpty(): boolean

检查当前缓冲区是否为空。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​LRUCache.isEmpty9+​替代。

系统能力: SystemCapability.Utils.Lang

返回值:

类型

说明

boolean

如果当前缓冲区不包含任何值,则返回true。

示例:

let pro = new util.LruBuffer();
pro.put(2,10);
let result = pro.isEmpty();

get(deprecated)

get(key: K): V | undefined

表示要查询的键。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​LRUCache.get9+​替代。

系统能力: SystemCapability.Utils.Lang

参数:

参数名

类型

必填

说明

key

K

要查询的键。

返回值:

类型

说明

V | undefined

如果指定的键存在于缓冲区中,则返回与键关联的值;否则返回undefined。

示例:

let pro = new util.LruBuffer();
pro.put(2,10);
let result  = pro.get(2);

put(deprecated)

put(key: K,value: V): V

将键值对添加到缓冲区。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​LRUCache.put9+​替代。

系统能力: SystemCapability.Utils.Lang

参数:

参数名

类型

必填

说明

key

K

要添加的密钥。

value

V

指示与要添加的键关联的值。

返回值:

类型

说明

V

返回与添加的键关联的值;如果要添加的键已经存在,则返回原始值,如果键或值为空,则抛出此异常。

示例:

let pro = new util.LruBuffer();
let result = pro.put(2,10);

values(deprecated)

values(): V[]

获取当前缓冲区中所有值从最近访问到最近最少访问的顺序列表。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​LRUCache.values9+​替代。

系统能力: SystemCapability.Utils.Lang

返回值:

类型

说明

V []

按从最近访问到最近最少访问的顺序返回当前缓冲区中所有值的列表。

示例:

let pro = new util.LruBuffer();
pro.put(2,10);
pro.put(2,"anhu");
pro.put("afaf","grfb");
let result = pro.values();

keys(deprecated)

keys(): K[]

获取当前缓冲区中所有键从最近访问到最近最少访问的升序列表。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​LRUCache.keys9+​替代。

系统能力: SystemCapability.Utils.Lang

返回值:

类型

说明

K []

按升序返回当前缓冲区中所有键的列表,从最近访问到最近最少访问。

示例:

let pro = new util.LruBuffer();
pro.put(2,10);
let result = pro.keys();

remove(deprecated)

remove(key: K): V | undefined

从当前缓冲区中删除指定的键及其关联的值。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​LRUCache.remove9+​替代。

系统能力: SystemCapability.Utils.Lang

参数:

参数名

类型

必填

说明

key

K

要删除的密钥。

返回值:

类型

说明

V | undefined

返回一个包含已删除键值对的Optional对象;如果key不存在,则返回一个空的Optional对象,如果key为null,则抛出异常。

示例:

let pro = new util.LruBuffer();
pro.put(2,10);
let result = pro.remove(20);

afterRemoval(deprecated)

afterRemoval(isEvict: boolean,key: K,value: V,newValue: V): void

删除值后执行后续操作。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​LRUCache.afterRemoval9+​替代。

系统能力: SystemCapability.Utils.Lang

参数:

参数名

类型

必填

说明

isEvict

boolean

因容量不足而调用该方法时,参数值为true,其他情况为false。

key

K

表示删除的键。

value

V

表示删除的值。

newValue

V

如果已调用put方法并且要添加的键已经存在,则参数值是关联的新值。其他情况下参数值为空。

示例:

let arr = [];
class ChildLruBuffer<K, V> extends util.LruBuffer<K, V>
{
    constructor()
    {
        super();
    }
    afterRemoval(isEvict, key, value, newValue)
    {
        if (isEvict === false)
        {
            arr = [key, value, newValue];
        }
    }
}
let lru = new ChildLruBuffer();
lru.afterRemoval(false,10,30,null);

contains(deprecated)

contains(key: K): boolean

检查当前缓冲区是否包含指定的键。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​LRUCache.contains9+​替代。

系统能力: SystemCapability.Utils.Lang

参数:

参数名

类型

必填

说明

key

K

表示要检查的键。

返回值:

类型

说明

boolean

如果缓冲区包含指定的键,则返回 true。

示例:

let pro = new util.LruBuffer();
pro.put(2,10);
let result = pro.contains(20);

createDefault(deprecated)

createDefault(key: K): V

如果未计算特定键的值,则执行后续操作,参数表示丢失的键,返回与键关联的值。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​LRUCache.createDefault9+​替代。

系统能力: SystemCapability.Utils.Lang

参数:

参数名

类型

必填

说明

key

K

表示丢失的键。

返回值:

类型

说明

V

返回与键关联的值。

示例:

let pro = new util.LruBuffer();
let result = pro.createDefault(50);

entries(deprecated)

entries(): IterableIterator<[K,V]>

允许迭代包含在这个对象中的所有键值对。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​LRUCache.entries9+​替代。

系统能力: SystemCapability.Utils.Lang

返回值:

类型

说明

[K, V]

返回一个可迭代数组。

示例:

let pro = new util.LruBuffer();
pro.put(2,10);
let result = pro.entries();

[Symbol.iterator](deprecated)

[Symbol.iterator](): IterableIterator<[K, V]>

返回一个键值对形式的二维数组。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​LRUCache.Symbol.iterator9+​替代。

系统能力: SystemCapability.Utils.Lang

返回值:

类型

说明

[K, V]

返回一个键值对形式的二维数组。

示例:

let pro = new util.LruBuffer();
pro.put(2,10);
let result = pro[Symbol.iterator]();

Scope(deprecated)

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​ScopeHelper9+​替代。

constructor(deprecated)

constructor(lowerObj: ScopeType, upperObj: ScopeType)

用于创建指定下限和上限的作用域实例的构造函数,返回一个Scope对象。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​ScopeHelper.constructor9+​替代。

系统能力: SystemCapability.Utils.Lang

参数:

参数名

类型

必填

说明

lowerObj

​ScopeType​

指定作用域实例的下限。

upperObj

​ScopeType​

指定作用域实例的上限。

示例:

let tempLower = new Temperature(30);
let tempUpper = new Temperature(40);
let range = new util.Scope(tempLower, tempUpper);

toString(deprecated)

toString(): string

该字符串化方法返回一个包含当前范围的字符串表示形式。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​ScopeHelper.toString9+​替代。

系统能力: SystemCapability.Utils.Lang

返回值:

类型

说明

string

返回包含当前范围对象的字符串表示形式。

示例:

let tempLower = new Temperature(30);
let tempUpper = new Temperature(40);
let range = new util.Scope(tempLower, tempUpper);
let result = range.toString();

intersect(deprecated)

intersect(range: Scope): Scope

获取给定范围和当前范围的交集。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​ScopeHelper.intersect9+​替代。

系统能力: SystemCapability.Utils.Lang

参数:

参数名

类型

必填

说明

range

​Scope​

传入一个给定范围。

返回值:

类型

说明

​Scope​

返回给定范围和当前范围的交集。

示例:

let tempLower = new Temperature(30);
let tempUpper = new Temperature(40);
let range = new util.Scope(tempLower, tempUpper);
let tempMiDF = new Temperature(35);
let tempMidS = new Temperature(39);
let rangeFir = new util.Scope(tempMiDF, tempMidS);
range.intersect(rangeFir );

intersect(deprecated)

intersect(lowerObj:ScopeType,upperObj:ScopeType):Scope

获取当前范围与给定下限和上限范围的交集。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​ScopeHelper.intersect9+​替代。

系统能力: SystemCapability.Utils.Lang

参数:

参数名

类型

必填

说明

lowerObj

​ScopeType​

给定范围的下限。

upperObj

​ScopeType​

给定范围的上限。

返回值:

类型

说明

​Scope​

返回当前范围与给定下限和上限范围的交集。

示例:

let tempLower = new Temperature(30);
let tempUpper = new Temperature(40);
let tempMiDF = new Temperature(35);
let tempMidS = new Temperature(39);
let range = new util.Scope(tempLower, tempUpper);
let result = range.intersect(tempMiDF, tempMidS);

getUpper(deprecated)

getUpper(): ScopeType

获取当前范围的上限。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​ScopeHelper.getUpper9+​替代。

系统能力: SystemCapability.Utils.Lang

返回值:

类型

说明

​ScopeType​

返回当前范围的上限值。

示例:

let tempLower = new Temperature(30);
let tempUpper = new Temperature(40);
let range = new util.Scope(tempLower, tempUpper);
let result = range.getUpper();

getLower(deprecated)

getLower(): ScopeType

获取当前范围的下限。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​ScopeHelper.getLower9+​替代。

系统能力: SystemCapability.Utils.Lang

返回值:

类型

说明

​ScopeType​

返回当前范围的下限值。

示例:

let tempLower = new Temperature(30);
let tempUpper = new Temperature(40);
let range = new util.Scope(tempLower, tempUpper);
let result = range.getLower();

expand(deprecated)

expand(lowerObj: ScopeType,upperObj: ScopeType): Scope

创建并返回包括当前范围和给定下限和上限的并集。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​ScopeHelper.expand9+​替代。

系统能力: SystemCapability.Utils.Lang

参数:

参数名

类型

必填

说明

lowerObj

​ScopeType​

给定范围的下限。

upperObj

​ScopeType​

给定范围的上限。

返回值:

类型

说明

​Scope​

返回当前范围和给定下限和上限的并集。

示例:

let tempLower = new Temperature(30);
let tempUpper = new Temperature(40);
let tempMiDF = new Temperature(35);
let tempMidS = new Temperature(39);
let range = new util.Scope(tempLower, tempUpper);
let result = range.expand(tempMiDF, tempMidS);

expand(deprecated)

expand(range: Scope): Scope

创建并返回包括当前范围和给定范围的并集。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​ScopeHelper.expand9+​替代。

系统能力: SystemCapability.Utils.Lang

参数:

参数名

类型

必填

说明

range

​Scope​

传入一个给定范围。

返回值:

类型

说明

​Scope​

返回包括当前范围和给定范围的并集。

示例:

let tempLower = new Temperature(30);
let tempUpper = new Temperature(40);
let tempMiDF = new Temperature(35);
let tempMidS = new Temperature(39);
let range = new util.Scope(tempLower, tempUpper);
let rangeFir = new util.Scope(tempMiDF, tempMidS);
let result = range.expand(rangeFir);

expand(deprecated)

expand(value: ScopeType): Scope

创建并返回包括当前范围和给定值的并集。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​ScopeHelper.expand9+​替代。

系统能力: SystemCapability.Utils.Lang

参数:

参数名

类型

必填

说明

value

​ScopeType​

传入一个给定值。

返回值:

类型

说明

​Scope​

返回包括当前范围和给定值的并集。

示例:

let tempLower = new Temperature(30);
let tempUpper = new Temperature(40);
let tempMiDF = new Temperature(35);
let range = new util.Scope(tempLower, tempUpper);
let result = range.expand(tempMiDF);

contains(deprecated)

contains(value: ScopeType): boolean

检查给定value是否包含在当前范围内。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​ScopeHelper.contains9+​替代。

系统能力: SystemCapability.Utils.Lang

参数:

参数名

类型

必填

说明

value

​ScopeType​

传入一个给定值。

返回值:

类型

说明

boolean

如果给定值包含在当前范围内返回true,否则返回false。

示例:

let tempLower = new Temperature(30);
let tempUpper = new Temperature(40);
let tempMiDF = new Temperature(35);
let range = new util.Scope(tempLower, tempUpper);
range.contains(tempMiDF);

contains(deprecated)

contains(range: Scope): boolean

检查给定range是否在当前范围内。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​ScopeHelper.contains9+​替代。

系统能力: SystemCapability.Utils.Lang

参数:

参数名

类型

必填

说明

range

​Scope​

传入一个给定范围。

返回值:

类型

说明

boolean

如果给定范围包含在当前范围内返回true,否则返回false。

示例:

let tempLower = new Temperature(30);
let tempUpper = new Temperature(40);
let range = new util.Scope(tempLower, tempUpper);
let tempLess = new Temperature(20);
let tempMore = new Temperature(45);
let rangeSec = new util.Scope(tempLess, tempMore);
let result = range.contains(rangeSec);

clamp(deprecated)

clamp(value: ScopeType): ScopeType

将给定值限定到当前范围内。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​ScopeHelper.clamp9+​替代。

系统能力: SystemCapability.Utils.Lang

参数:

参数名

类型

必填

说明

value

​ScopeType​

传入的给定值。

返回值:

类型

说明

​ScopeType​

如果传入的value小于下限,则返回lowerObj;如果大于上限值则返回upperObj;如果在当前范围内,则返回value。

示例:

let tempLower = new Temperature(30);
let tempUpper = new Temperature(40);
let tempMiDF = new Temperature(35);
let range = new util.Scope(tempLower, tempUpper);
let result = range.clamp(tempMiDF);

Base64(deprecated)

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​Base64Helper9+​替代。

constructor(deprecated)

constructor()

Base64的构造函数。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​Base64Helper.constructor9+​替代。

系统能力: SystemCapability.Utils.Lang

示例:

let base64 = new  util.Base64();

encodeSync(deprecated)

encodeSync(src: Uint8Array): Uint8Array

通过输入参数编码后输出对应文本。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​Base64Helper.encodeSync9+​替代。

系统能力: SystemCapability.Utils.Lang

参数:

参数名

类型

必填

说明

src

Uint8Array

编码输入Uint8数组。

返回值:

类型

说明

Uint8Array

返回编码后新分配的Uint8数组。

示例:

let that = new util.Base64();
let array = new Uint8Array([115,49,51]);
let result = that.encodeSync(array);

encodeToStringSync(deprecated)

encodeToStringSync(src: Uint8Array): string

通过输入参数编码后输出对应文本。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​Base64Helper.encodeToStringSync9+​替代。

系统能力: SystemCapability.Utils.Lang

参数:

参数名

类型

必填

说明

src

Uint8Array

编码输入Uint8数组。

返回值:

类型

说明

string

返回编码后的字符串。

示例:

let that = new util.Base64();
let array = new Uint8Array([115,49,51]);
let result = that.encodeToStringSync(array);

decodeSync(deprecated)

decodeSync(src: Uint8Array | string): Uint8Array

通过输入参数解码后输出对应文本。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​Base64Helper.decodeSync9+​替代。

系统能力: SystemCapability.Utils.Lang

参数:

参数名

类型

必填

说明

src

Uint8Array | string

解码输入Uint8数组或者字符串。

返回值:

类型

说明

Uint8Array

返回解码后新分配的Uint8数组。

示例:

let that = new util.Base64();
let buff = 'czEz';
let result = that.decodeSync(buff);

encode(deprecated)

encode(src: Uint8Array): Promise<Uint8Array>

通过输入参数异步编码后输出对应文本。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​Base64Helper.encode9+​替代。

系统能力: SystemCapability.Utils.Lang

参数:

参数名

类型

必填

说明

src

Uint8Array

异步编码输入Uint8数组。

返回值:

类型

说明

Promise<Uint8Array>

返回异步编码后新分配的Uint8数组。

示例:

let that = new util.Base64();
let array = new Uint8Array([115,49,51]);
let rarray = new Uint8Array([99,122,69,122]);
that.encode(array).then(val=>{    
    for (var i = 0; i < rarray.length; i++) {        
        console.log(val[i].toString())
    }
})

encodeToString(deprecated)

encodeToString(src: Uint8Array): Promise<string>

通过输入参数异步编码后输出对应文本。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​Base64Helper.encodeToString9+​替代。

系统能力: SystemCapability.Utils.Lang

参数:

参数名

类型

必填

说明

src

Uint8Array

异步编码输入Uint8数组。

返回值:

类型

说明

Promise<string>

返回异步编码后的字符串。

示例:

let that = new util.Base64();
let array = new Uint8Array([115,49,51]);
that.encodeToString(array).then(val=>{    
    console.log(val)
})

decode(deprecated)

decode(src: Uint8Array | string): Promise<Uint8Array>

通过输入参数异步解码后输出对应文本。

说明

从API version 8开始支持,从API version 9开始废弃,建议使用​​Base64Helper.decode9+​替代。

系统能力: SystemCapability.Utils.Lang

参数:

参数名

类型

必填

说明

src

Uint8Array | string

异步解码输入Uint8数组或者字符串。

返回值:

类型

说明

Promise<Uint8Array>

返回异步解码后新分配的Uint8数组。

示例:

let that = new util.Base64();
let array = new Uint8Array([99,122,69,122]);
let rarray = new Uint8Array([115,49,51]);
that.decode(array).then(val=>{    
    for (var i = 0; i < rarray.length; i++) {        
        console.log(val[i].toString())
    }
})



文章转载自:​​https://developer.harmonyos.com/cn/docs/documentation/doc-references-V3/js-apis-util-0000001428062016-V3?catalogVersion=V3#ZH-CN_TOPIC_0000001428062016__decodedeprecated-1​

已于2023-4-11 17:35:23修改
收藏
回复
举报
回复
    相关推荐