util工具函数
说明: 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 开发前请熟悉鸿蒙开发指导文档 :[]
该模块主要提供常用的工具函数,实现字符串编解码(TextEncoder,TextDecoder)、有理数运算(RationalNumber)、缓冲区管理(LruBuffer)、范围判断(Scope)、Base64编解码(Base64)、内置对象类型检查(Types)等功能。
导入模块
util.printf
printf(format: string, ...args: Object[]): string
通过式样化字符串对输入的内容按特定格式输出。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
util.getErrorString
getErrorString(errno: number): string
获取系统错误码对应的详细信息。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
util.callbackWrapper
callbackWrapper(original: Function): (err: Object, value: Object )=>void
对异步函数进行回调化处理,回调中第一个参数将是拒绝原因(如果 Promise 已解决,则为 null),第二个参数将是已解决的值。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
util.promiseWrapper
promiseWrapper(original: (err: Object, value: Object) => void): Object
对异步函数处理并返回一个promise的版本。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
TextDecoder
属性
系统能力: 以下各项对应的系统能力均为SystemCapability.Utils.Lang。
constructor
constructor(encoding?: string, options?: { fatal?: boolean; ignoreBOM?: boolean },)
TextDecoder的构造函数。
系统能力: SystemCapability.Utils.Lang
参数:
表1 options
示例:
decode
decode(input: Uint8Array, options?: { stream?: false }): string
通过输入参数解码后输出对应文本。
系统能力: SystemCapability.Utils.Lang
参数:
表2 options
返回值:
示例:
TextEncoder
属性
系统能力: 以下各项对应的系统能力均为SystemCapability.Utils.Lang。
constructor
constructor()
TextEncoder的构造函数。
系统能力: SystemCapability.Utils.Lang
示例:
encode
encode(input?: string): Uint8Array
通过输入参数编码后输出对应文本。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
encodeInto
encodeInto(input: string, dest: Uint8Array, ): { read: number; written: number }
放置生成的UTF-8编码文本。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
RationalNumber8+
constructor8+
constructor(numerator: number,denominator: number)
RationalNumber的构造函数。
系统能力: SystemCapability.Utils.Lang
参数:
示例:
createRationalFromString8+
static createRationalFromString(rationalString: string): RationalNumber
基于给定的字符串创建一个RationalNumber对象。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
compareTo8+
compareTo(another: RationalNumber): number
将当前的RationalNumber对象与给定的对象进行比较。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
valueOf8+
valueOf(): number
以整数形式或者浮点数的形式获取当前RationalNumber对象的值。
系统能力: SystemCapability.Utils.Lang
返回值:
示例:
equals8+
equals(obj: Object): boolean
将当前的RationalNumber对象与给定的对象进行比较是否相等。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
getCommonDivisor8+
static getCommonDivisor(number1: number,number2: number): number
获取两个指定整数的最大公约数。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
getNumerator8+
getNumerator(): number
获取当前RationalNumber对象的分子。
系统能力: SystemCapability.Utils.Lang
返回值:
示例:
getDenominator8+
getDenominator(): number
获取当前RationalNumber对象的分母。
系统能力: SystemCapability.Utils.Lang
返回值:
示例:
isZero8+
isZero():boolean
检查当前RationalNumber对象是否为0。
系统能力: SystemCapability.Utils.Lang
返回值:
示例:
isNaN8+
isNaN(): boolean
检查当前RationalNumber对象是否表示非数字(NaN)值。
系统能力: SystemCapability.Utils.Lang
返回值:
示例:
isFinite8+
isFinite():boolean
检查当前RationalNumber对象是否表示一个有限值。
系统能力: SystemCapability.Utils.Lang
返回值:
示例:
toString8+
toString(): string
获取当前RationalNumber对象的字符串表示形式。
系统能力: SystemCapability.Utils.Lang
返回值:
示例:
LruBuffer8+
属性
系统能力: 以下各项对应的系统能力均为SystemCapability.Utils.Lang。
示例:
constructor8+
constructor(capacity?: number)
默认构造函数用于创建一个新的LruBuffer实例,默认容量为64。
系统能力: SystemCapability.Utils.Lang
参数:
示例:
updateCapacity8+
updateCapacity(newCapacity: number): void
将缓冲区容量更新为指定容量,如果newCapacity小于或等于0,则抛出异常。
系统能力: SystemCapability.Utils.Lang
参数:
示例:
toString8+
toString(): string
返回对象的字符串表示形式。
系统能力: SystemCapability.Utils.Lang
返回值:
示例:
getCapacity8+
getCapacity(): number
获取当前缓冲区的容量。
系统能力: SystemCapability.Utils.Lang
返回值:
示例:
clear8+
clear(): void
从当前缓冲区清除键值对。后续会调用afterRemoval()方法执行后续操作。
系统能力: SystemCapability.Utils.Lang
示例:
getCreateCount8+
getCreateCount(): number
获取createDefault()返回值的次数。
系统能力: SystemCapability.Utils.Lang
返回值:
示例:
getMissCount8+
getMissCount(): number
获取查询值不匹配的次数。
系统能力: SystemCapability.Utils.Lang
返回值:
示例:
getRemovalCount8+
getRemovalCount(): number
获取从缓冲区中逐出值的次数。
系统能力: SystemCapability.Utils.Lang
返回值:
示例:
getMatchCount8+
getMatchCount(): number
获取查询值匹配成功的次数。
系统能力: SystemCapability.Utils.Lang
返回值:
示例:
getPutCount8+
getPutCount(): number
获取将值添加到缓冲区的次数。
系统能力: SystemCapability.Utils.Lang
返回值:
示例:
isEmpty8+
isEmpty(): boolean
检查当前缓冲区是否为空。
系统能力: SystemCapability.Utils.Lang
返回值:
示例:
get8+
get(key: K): V | undefined
表示要查询的键。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
put8+
put(key: K,value: V): V
将键值对添加到缓冲区。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
values8+
values(): V[]
获取当前缓冲区中所有值从最近访问到最近最少访问的顺序列表 。
系统能力: SystemCapability.Utils.Lang
返回值:
示例:
keys8+
keys(): K[]
获取当前缓冲区中所有键从最近访问到最近最少访问的升序列表。
系统能力: SystemCapability.Utils.Lang
返回值:
示例:
remove8+
remove(key: K): V | undefined
从当前缓冲区中删除指定的键及其关联的值。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
afterRemoval8+
afterRemoval(isEvict: boolean,key: K,value: V,newValue: V): void
删除值后执行后续操作。
系统能力: SystemCapability.Utils.Lang
参数:
示例:
contains8+
contains(key: K): boolean
检查当前缓冲区是否包含指定的键。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
createDefault8+
createDefault(key: K): V
如果未计算特定键的值,则执行后续操作,参数表示丢失的键,返回与键关联的值。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
entries8+
entries(): IterableIterator<[K,V]>
允许迭代包含在这个对象中的所有键值对。
系统能力: SystemCapability.Utils.Lang
返回值:
示例:
[Symbol.iterator]8+
Symbol.iterator: IterableIterator<[K, V]>
返回一个键值对形式的二维数组。
系统能力: SystemCapability.Utils.Lang
返回值:
示例:
Scope8+
ScopeType8+
用于表示范围中的值的类型。该类型的值,类型可以为ScopeComparable或number。
ScopeComparable类型的值需要实现compareTo方法,确保传入的数据具有可比性。
构造新类,实现compareTo方法。后续示例代码中,均通过Temperature,获取[ScopeType]的实例化对象。
示例:
constructor8+
constructor(lowerObj: ScopeType, upperObj: ScopeType)
用于创建指定下限和上限的作用域实例的构造函数,返回一个Scope对象。
系统能力: SystemCapability.Utils.Lang
参数:
示例:
toString8+
toString(): string
该字符串化方法返回一个包含当前范围的字符串表示形式。
系统能力: SystemCapability.Utils.Lang
返回值:
示例:
intersect8+
intersect(range: Scope): Scope
获取给定范围和当前范围的交集。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
intersect8+
intersect(lowerObj:ScopeType,upperObj:ScopeType):Scope
获取当前范围与给定下限和上限范围的交集。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
getUpper8+
getUpper(): ScopeType
获取当前范围的上限。
系统能力: SystemCapability.Utils.Lang
返回值:
示例:
getLower8+
getLower(): ScopeType
获取当前范围的下限。
系统能力: SystemCapability.Utils.Lang
返回值:
示例:
expand8+
expand(lowerObj: ScopeType,upperObj: ScopeType): Scope
创建并返回包括当前范围和给定下限和上限的并集。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
expand8+
expand(range: Scope): Scope
创建并返回包括当前范围和给定范围的并集。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
expand8+
expand(value: ScopeType): Scope
创建并返回包括当前范围和给定值的并集。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
contains8+
contains(value: ScopeType): boolean
检查给定value是否包含在当前范围内。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
contains8+
contains(range: Scope): boolean
检查给定range是否在当前范围内。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
clamp8+
clamp(value: ScopeType): ScopeType
将给定值限定到当前范围内。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
Base648+
constructor8+
constructor()
Base64的构造函数。
系统能力: SystemCapability.Utils.Lang
示例:
encodeSync8+
encodeSync(src: Uint8Array): Uint8Array
通过输入参数编码后输出对应文本。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
encodeToStringSync8+
encodeToStringSync(src: Uint8Array): string
通过输入参数编码后输出对应文本。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
decodeSync8+
decodeSync(src: Uint8Array | string): Uint8Array
通过输入参数解码后输出对应文本。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
encode8+
encode(src: Uint8Array): Promise
通过输入参数异步编码后输出对应文本。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
encodeToString8+
encodeToString(src: Uint8Array): Promise
通过输入参数异步编码后输出对应文本。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
decode8+
decode(src: Uint8Array | string): Promise
通过输入参数异步解码后输出对应文本。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
types8+
constructor8+
constructor()
Types的构造函数。
系统能力: SystemCapability.Utils.Lang
示例:
isAnyArrayBuffer8+
isAnyArrayBuffer(value: Object): boolean
检查输入的value是否是ArrayBuffer类型。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
isArrayBufferView8+
isArrayBufferView(value: Object): boolean
检查输入的value是否是内置ArrayBufferView辅助类型。
ArrayBufferView辅助类型包括:Int8Array、Int16Array、Int32Array、Uint8Array、Uint8ClampedArray、Uint32Array、Float32Array、Float64Array、DataView。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
isArgumentsObject8+
isArgumentsObject(value: Object): boolean
检查输入的value是否是一个arguments对象类型。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
isArrayBuffer8+
isArrayBuffer(value: Object): boolean
检查输入的value是否是ArrayBuffer类型。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
isAsyncFunction8+
isAsyncFunction(value: Object): boolean
检查输入的value是否是一个异步函数类型。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
isBooleanObject8+
isBooleanObject(value: Object): boolean
检查输入的value是否是一个Boolean对象类型。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
isBoxedPrimitive8+
isBoxedPrimitive(value: Object): boolean
检查输入的value是否是Boolean或Number或String或Symbol对象类型。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
isDataView8+
isDataView(value: Object): boolean
检查输入的value是否是DataView类型。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
isDate8+
isDate(value: Object): boolean
检查输入的value是否是Date类型。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
isExternal8+
isExternal(value: Object): boolean
检查输入的value是否是native External类型。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
isFloat32Array8+
isFloat32Array(value: Object): boolean
检查输入的value是否是Float32Array数组类型。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
isFloat64Array8+
isFloat64Array(value: Object): boolean
检查输入的value是否是Float64Array数组类型。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
isGeneratorFunction8+
isGeneratorFunction(value: Object): boolean
检查输入的value是否是generator函数类型。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
isGeneratorObject8+
isGeneratorObject(value: Object): boolean
检查输入的value是否是generator对象类型。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
isInt8Array8+
isInt8Array(value: Object): boolean
检查输入的value是否是Int8Array数组类型。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
isInt16Array8+
isInt16Array(value: Object): boolean
检查输入的value是否是Int16Array数组类型。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
isInt32Array8+
isInt32Array(value: Object): boolean
检查输入的value是否是Int32Array数组类型。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
isMap8+
isMap(value: Object): boolean
检查输入的value是否是Map类型。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
isMapIterator8+
isMapIterator(value: Object): boolean
检查输入的value是否是Map的Iterator类型。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
isNativeError8+
isNativeError(value: Object): boolean
检查输入的value是否是Error类型。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
isNumberObject8+
isNumberObject(value: Object): boolean
检查输入的value是否是Number对象类型。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
isPromise8+
isPromise(value: Object): boolean
检查输入的value是否是Promise类型。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
isProxy8+
isProxy(value: Object): boolean
检查输入的value是否是Proxy类型。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
isRegExp8+
isRegExp(value: Object): boolean
检查输入的value是否是RegExp类型。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
isSet8+
isSet(value: Object): boolean
检查输入的value是否是Set类型。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
isSetIterator8+
isSetIterator(value: Object): boolean
检查输入的value是否是Set的Iterator类型。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
isStringObject8+
isStringObject(value: Object): boolean
检查输入的value是否是String对象类型。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
isSymbolObjec8+
isSymbolObject(value: Object): boolean
检查输入的value是否是Symbol对象类型。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
isTypedArray8+
isTypedArray(value: Object): boolean
检查输入的value是否是TypedArray类型的辅助类型。
TypedArray类型的辅助类型,包括Int8Array、Int16Array、Int32Array、Uint8Array、Uint8ClampedArray、Uint16Array、Uint32Array、Float32Array、Float64Array、DataView。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
isUint8Array8+
isUint8Array(value: Object): boolean
检查输入的value是否是Uint8Array数组类型。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
isUint8ClampedArray8+
isUint8ClampedArray(value: Object): boolean
检查输入的value是否是Uint8ClampedArray数组类型。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
isUint16Array8+
isUint16Array(value: Object): boolean
检查输入的value是否是Uint16Array数组类型。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
isUint32Array8+
isUint32Array(value: Object): boolean
检查输入的value是否是Uint32Array数组类型。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
isWeakMap8+
isWeakMap(value: Object): boolean
检查输入的value是否是WeakMap类型。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
isWeakSet8+
isWeakSet(value: Object): boolean
检查输入的value是否是WeakSet类型。
系统能力: SystemCapability.Utils.Lang
参数:
返回值:
示例:
版权声明:
本文来源网络,所有图片文章版权属于原作者,如有侵权,联系删除。
本文网址:https://www.bianchenghao6.com/h6javajc/24824.html