
HarmonyOS API:@ohos.util (util工具函数)
版本:v3.1 Beta
@ohos.util (util工具函数)
Base64Helper9+
constructor9+
constructor()
Base64Helper的构造函数。
系统能力: SystemCapability.Utils.Lang
示例:
encodeSync9+
encodeSync(src: Uint8Array): Uint8Array
通过输入参数编码后输出对应文本。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
src | Uint8Array | 是 | 编码输入Uint8数组。 |
返回值:
类型 | 说明 |
Uint8Array | 返回编码后新分配的Uint8数组。 |
示例:
encodeToStringSync9+
encodeToStringSync(src: Uint8Array): string
通过输入参数编码后输出对应文本。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
src | Uint8Array | 是 | 编码输入Uint8数组。 |
返回值:
类型 | 说明 |
string | 返回编码后的字符串。 |
示例:
decodeSync9+
decodeSync(src: Uint8Array | string): Uint8Array
通过输入参数解码后输出对应文本。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
src | Uint8Array | string | 是 | 解码输入Uint8数组或者字符串。 |
返回值:
类型 | 说明 |
Uint8Array | 返回解码后新分配的Uint8数组。 |
示例:
encode9+
encode(src: Uint8Array): Promise<Uint8Array>
通过输入参数异步编码后输出对应文本。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
src | Uint8Array | 是 | 异步编码输入Uint8数组。 |
返回值:
类型 | 说明 |
Promise<Uint8Array> | 返回异步编码后新分配的Uint8数组。 |
示例:
encodeToString9+
encodeToString(src: Uint8Array): Promise<string>
通过输入参数异步编码后输出对应文本。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
src | Uint8Array | 是 | 异步编码输入Uint8数组。 |
返回值:
类型 | 说明 |
Promise<string> | 返回异步编码后的字符串。 |
示例:
decode9+
decode(src: Uint8Array | string): Promise<Uint8Array>
通过输入参数异步解码后输出对应文本。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
src | Uint8Array | string | 是 | 异步解码输入Uint8数组或者字符串。 |
返回值:
类型 | 说明 |
Promise<Uint8Array> | 返回异步解码后新分配的Uint8数组。 |
示例:
types8+
constructor8+
constructor()
Types的构造函数。
系统能力: SystemCapability.Utils.Lang
示例:
isAnyArrayBuffer8+
isAnyArrayBuffer(value: Object): boolean
检查输入的value是否是ArrayBuffer类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是ArrayBuffer类型为true,反之为false。 |
示例:
isArrayBufferView8+
isArrayBufferView(value: Object): boolean
检查输入的value是否是内置ArrayBufferView辅助类型。
ArrayBufferView辅助类型包括:Int8Array、Int16Array、Int32Array、Uint8Array、Uint8ClampedArray、Uint32Array、Float32Array、Float64Array、DataView。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的ArrayBufferView辅助类型为true,反之为false。 |
示例:
isArgumentsObject8+
isArgumentsObject(value: Object): boolean
检查输入的value是否是一个arguments对象类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的arguments类型为true,反之为false。 |
示例:
isArrayBuffer8+
isArrayBuffer(value: Object): boolean
检查输入的value是否是ArrayBuffer类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的ArrayBuffer类型为true,反之为false。 |
示例:
isAsyncFunction8+
isAsyncFunction(value: Object): boolean
检查输入的value是否是一个异步函数类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的异步函数类型为true,反之为false。 |
示例:
isBooleanObject8+
isBooleanObject(value: Object): boolean
检查输入的value是否是一个Boolean对象类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的Boolean对象类型为true,反之为false。 |
示例:
isBoxedPrimitive8+
isBoxedPrimitive(value: Object): boolean
检查输入的value是否是Boolean或Number或String或Symbol对象类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的Boolean或Number或String或Symbol对象类型为true,反之为false。 |
示例:
isDataView8+
isDataView(value: Object): boolean
检查输入的value是否是DataView类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的DataView对象类型为true,反之为false。 |
示例:
isDate8+
isDate(value: Object): boolean
检查输入的value是否是Date类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的Date对象类型为true,反之为false。 |
示例:
isExternal8+
isExternal(value: Object): boolean
检查输入的value是否是native External类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含native External类型为true,反之为false。 |
示例:
isFloat32Array8+
isFloat32Array(value: Object): boolean
检查输入的value是否是Float32Array数组类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的Float32Array数组类型为true,反之为false。 |
示例:
isFloat64Array8+
isFloat64Array(value: Object): boolean
检查输入的value是否是Float64Array数组类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的Float64Array数组类型为true,反之为false。 |
示例:
isGeneratorFunction8+
isGeneratorFunction(value: Object): boolean
检查输入的value是否是generator函数类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的generator函数类型为true,反之为false。 |
示例:
isGeneratorObject8+
isGeneratorObject(value: Object): boolean
检查输入的value是否是generator对象类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的generator对象类型为true,反之为false。 |
示例:
isInt8Array8+
isInt8Array(value: Object): boolean
检查输入的value是否是Int8Array数组类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的Int8Array数组类型为true,反之为false。 |
示例:
isInt16Array8+
isInt16Array(value: Object): boolean
检查输入的value是否是Int16Array数组类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的Int16Array数组类型为true,反之为false。 |
示例:
isInt32Array8+
isInt32Array(value: Object): boolean
检查输入的value是否是Int32Array数组类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的Int32Array数组类型为true,反之为false。 |
示例:
isMap8+
isMap(value: Object): boolean
检查输入的value是否是Map类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的Map类型为true,反之为false。 |
示例:
isMapIterator8+
isMapIterator(value: Object): boolean
检查输入的value是否是Map的Iterator类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的Map的Iterator类型为true,反之为false。 |
示例:
isNativeError8+
isNativeError(value: Object): boolean
检查输入的value是否是Error类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的Error类型为true,反之为false。 |
示例:
isNumberObject8+
isNumberObject(value: Object): boolean
检查输入的value是否是Number对象类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的Number对象类型为true,反之为false。 |
示例:
isPromise8+
isPromise(value: Object): boolean
检查输入的value是否是Promise类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的Promise类型为true,反之为false。 |
示例:
isProxy8+
isProxy(value: Object): boolean
检查输入的value是否是Proxy类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的Proxy类型为true,反之为false。 |
示例:
isRegExp8+
isRegExp(value: Object): boolean
检查输入的value是否是RegExp类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的RegExp类型为true,反之为false。 |
示例:
isSet8+
isSet(value: Object): boolean
检查输入的value是否是Set类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的Set类型为true,反之为false。 |
示例:
isSetIterator8+
isSetIterator(value: Object): boolean
检查输入的value是否是Set的Iterator类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的Set的Iterator类型为true,反之为false。 |
示例:
isStringObject8+
isStringObject(value: Object): boolean
检查输入的value是否是String对象类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的String对象类型为true,反之为false。 |
示例:
isSymbolObjec8+
isSymbolObject(value: Object): boolean
检查输入的value是否是Symbol对象类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的Symbol对象类型为true,反之为false。 |
示例:
isTypedArray8+
isTypedArray(value: Object): boolean
检查输入的value是否是TypedArray类型的辅助类型。
TypedArray类型的辅助类型,包括Int8Array、Int16Array、Int32Array、Uint8Array、Uint8ClampedArray、Uint16Array、Uint32Array、Float32Array、Float64Array、DataView。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的TypedArray包含的类型为true,反之为false。 |
示例:
isUint8Array8+
isUint8Array(value: Object): boolean
检查输入的value是否是Uint8Array数组类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的Uint8Array数组类型为true,反之为false。 |
示例:
isUint8ClampedArray8+
isUint8ClampedArray(value: Object): boolean
检查输入的value是否是Uint8ClampedArray数组类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的Uint8ClampedArray数组类型为true,反之为false。 |
示例:
isUint16Array8+
isUint16Array(value: Object): boolean
检查输入的value是否是Uint16Array数组类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的Uint16Array数组类型为true,反之为false。 |
示例:
isUint32Array8+
isUint32Array(value: Object): boolean
检查输入的value是否是Uint32Array数组类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的Uint32Array数组类型为true,反之为false。 |
示例:
isWeakMap8+
isWeakMap(value: Object): boolean
检查输入的value是否是WeakMap类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的WeakMap类型为true,反之为false。 |
示例:
isWeakSet8+
isWeakSet(value: Object): boolean
检查输入的value是否是WeakSet类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的WeakSet类型为true,反之为false。 |
示例:
isBigInt64Array8+
isBigInt64Array(value: Object): boolean
检查输入的value是否是BigInt64Array类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的BigInt64Array类型为true,反之为false。 |
示例:
isBigUint64Array8+
isBigUint64Array(value: Object): boolean
检查输入的value是否是BigUint64Array类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的BigUint64Array类型为true,反之为false。 |
示例:
isModuleNamespaceObject8+
isModuleNamespaceObject(value: Object): boolean
检查输入的value是否是Module Namespace Object类型。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
value | Object | 是 | 待检测对象。 |
返回值:
类型 | 说明 |
boolean | 判断的结果,如果是内置包含的Module Namespace Object类型为true,反之为false。 |
示例:
