js-apis-util.md 60.0 KB
Newer Older
Z
zengyawen 已提交
1 2
# util工具函数

Z
zengyawen 已提交
3

Z
zengyawen 已提交
4 5
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
Z
zengyawen 已提交
6

Z
zengyawen 已提交
7

Z
zengyawen 已提交
8 9 10
该模块主要提供常用的工具函数,实现字符串编解码(TextEncoder,TextDecoder)、有理数运算(RationalNumber)、缓冲区管理(LruBuffer)、范围判断(Scope)、Base64编解码(Base64)、内置对象类型检查(Types)等功能。


Z
zengyawen 已提交
11
## 导入模块
Z
zengyawen 已提交
12 13

```
Z
zengyawen 已提交
14
import util from '@ohos.util';
Z
zengyawen 已提交
15 16
```

Z
zengyawen 已提交
17 18
## util.printf

Z
zengyawen 已提交
19
printf(format: string,  ...args: Object[]): string
Z
zengyawen 已提交
20 21 22

通过式样化字符串对输入的内容按特定格式输出。

Z
zengyawen 已提交
23 24 25
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
26 27 28 29 30
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | format | string | 是 | 式样化字符串。 |
  | ...args | Object[] | 否 | 待式样化数据。 |

Z
zengyawen 已提交
31
**返回值:**
Z
zengyawen 已提交
32 33 34 35
  | 类型 | 说明 |
  | -------- | -------- |
  | string | 按特定格式式样化后的字符串。 |

Z
zengyawen 已提交
36
**示例:**
Z
zengyawen 已提交
37 38 39 40 41 42 43 44 45
  ```
  var res = util.printf("%s", "hello world!");
  console.log(res);
  ```


## util.getErrorString

getErrorString(errno: number): string
Z
zengyawen 已提交
46 47 48

获取系统错误码对应的详细信息。

Z
zengyawen 已提交
49 50 51
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
52 53 54 55
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | errno | number | 是 | 系统发生错误产生的错误码。 |

Z
zengyawen 已提交
56
**返回值:**
Z
zengyawen 已提交
57 58 59 60
  | 类型 | 说明 |
  | -------- | -------- |
  | string | 错误码对应的详细信息。 |

Z
zengyawen 已提交
61
**示例:**
Z
zengyawen 已提交
62 63 64 65 66 67 68 69 70
  ```
  var errnum = 10; // 10:a system error number
  var result = util.getErrorString(errnum);
  console.log("result = " + result);
  ```


## util.callbackWrapper

Z
zengyawen 已提交
71
callbackWrapper(original: Function): (err: Object, value: Object )=>void
Z
zengyawen 已提交
72 73 74

对异步函数进行回调化处理,回调中第一个参数将是拒绝原因(如果 Promise 已解决,则为 null),第二个参数将是已解决的值。

Z
zengyawen 已提交
75 76 77 78
**系统能力:** SystemCapability.Utils.Lang

**参数:**

Z
zengyawen 已提交
79 80 81 82
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | original | Function | 是 | 异步函数。 |

Z
zengyawen 已提交
83
**返回值:**
Z
zengyawen 已提交
84 85 86 87
  | 类型 | 说明 |
  | -------- | -------- |
  | Function | 返回一个第一个参数是拒绝原因(如果 Promise 已解决,则为 null),第二个参数是已解决的回调函数。 |

Z
zengyawen 已提交
88
**示例:**
Z
zengyawen 已提交
89 90 91 92 93 94
  ```
  async function promiseFn() {
      return Promise.reject('value');
  }
  var cb = util.callbackWrapper(promiseFn);
  cb((err, ret) => {
Z
zengyawen 已提交
95 96
      console.log(err);
      console.log(ret);
Z
zengyawen 已提交
97 98 99 100 101 102 103
  })
  ```


## util.promiseWrapper

promiseWrapper(original: (err: Object, value: Object) => void): Object
Z
zengyawen 已提交
104 105 106

对异步函数处理并返回一个promise的版本。

Z
zengyawen 已提交
107 108 109
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
110 111 112 113
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | original | Function | 是 | 异步函数。 |

Z
zengyawen 已提交
114
**返回值:**
Z
zengyawen 已提交
115 116 117 118
  | 类型 | 说明 |
  | -------- | -------- |
  | Function | 采用遵循常见的错误优先的回调风格的函数(也就是将 (err, value) => ... 回调作为最后一个参数),并返回一个返回 promise 的版本。 |

Z
zengyawen 已提交
119
**示例:**
Z
zengyawen 已提交
120 121
  ```
  function aysnFun(str1, str2, callback) {
122
      if (typeof str1 === 'string' && typeof str2 === 'string') {
Z
zengyawen 已提交
123 124 125 126 127 128 129
          callback(null, str1 + str2);
      } else {
          callback('type err');
      }
  }
  let newPromiseObj = util.promiseWrapper(aysnFun)("Hello", 'World');
  newPromiseObj.then(res => {
Z
zengyawen 已提交
130
      console.log(res);
Z
zengyawen 已提交
131 132 133 134 135 136 137 138
  })
  ```


## TextDecoder

### 属性

Z
zengyawen 已提交
139 140
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Utils.Lang。

Z
zengyawen 已提交
141 142 143 144
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| encoding | string | 是 | 否 | 编码格式。<br/>-&nbsp;支持格式:utf-8、ibm866、iso-8859-2、iso-8859-3、iso-8859-4、iso-8859-5、iso-8859-6、iso-8859-7、iso-8859-8、iso-8859-8-i、iso-8859-10、iso-8859-13、iso-8859-14、iso-8859-15、koi8-r、koi8-u、macintosh、windows-874、windows-1250、windows-1251、windows-1252、windows-1253、windows-1254、windows-1255、windows-1256、windows-1257、windows-1258、x-mac-cyrilli、gbk、gb18030、big5、euc-jp、iso-2022-jp、shift_jis、euc-kr、utf-16be、utf-16le。 |
| fatal | boolean | 是 | 否 | 是否显示致命错误。 |
Z
zengyawen 已提交
145
| ignoreBOM | boolean | 是 | 否 | 是否忽略BOM(byte&nbsp;order&nbsp;marker)标记,默认值为false&nbsp;,表示解码结果包含BOM标记。 |
Z
zengyawen 已提交
146 147 148 149


### constructor

S
shikai-123 已提交
150
constructor(encoding?: string, options?: { fatal?: boolean; ignoreBOM?: boolean },)
Z
zengyawen 已提交
151 152 153

TextDecoder的构造函数。

Z
zengyawen 已提交
154 155 156
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
157 158 159 160 161 162
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | encoding | string | 否 | 编码格式。 |
  | options | Object | 否 | 编码相关选项参数,存在两个属性fatal和ignoreBOM。 |

  **表1** options
Z
zengyawen 已提交
163

Z
zengyawen 已提交
164 165 166 167 168
  | 名称 | 参数类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | fatal | boolean | 否 | 是否显示致命错误。 |
  | ignoreBOM | boolean | 否 | 是否忽略BOM标记。 |

Z
zengyawen 已提交
169
**示例:**
Z
zengyawen 已提交
170
  ```
X
xdmal 已提交
171
  var textDecoder = new util.TextDecoder("utf-8",{ignoreBOM: true});
Z
zengyawen 已提交
172 173 174 175 176
  ```


### decode

S
shikai-123 已提交
177
decode(input: Uint8Array, options?: { stream?: false }): string
Z
zengyawen 已提交
178 179 180

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

Z
zengyawen 已提交
181 182 183
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
184 185
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
186
  | input | Unit8Array | 是 | 符合格式需要解码的数组。 |
Z
zengyawen 已提交
187
  | options | Object | 否 | 解码相关选项参数。 |
Z
zengyawen 已提交
188

Z
zengyawen 已提交
189
  **表2** options
Z
zengyawen 已提交
190

Z
zengyawen 已提交
191 192
  | 名称 | 参数类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
193
  | stream | boolean | 否 | 在随后的decode()调用中是否跟随附加数据块。如果以块的形式处理数据,则设置为true;如果处理最后的数据块或数据未分块,则设置为false。默认为false。 |
Z
zengyawen 已提交
194

Z
zengyawen 已提交
195
**返回值:**
Z
zengyawen 已提交
196 197 198 199
  | 类型 | 说明 |
  | -------- | -------- |
  | string | 解码后的数据。 |

Z
zengyawen 已提交
200
**示例:**
Z
zengyawen 已提交
201
  ```
X
xdmal 已提交
202
  var textDecoder = new util.TextDecoder("utf-8",{ignoreBOM: true});
Z
zengyawen 已提交
203 204 205 206 207 208 209 210 211 212 213
  var result = new Uint8Array(6);
  result[0] = 0xEF;
  result[1] = 0xBB;
  result[2] = 0xBF;
  result[3] = 0x61;
  result[4] = 0x62;
  result[5] = 0x63;
  console.log("input num:");
  for(var j= 0; j < 6; j++) {
      console.log(result[j]);
  }
X
xdmal 已提交
214
  var retStr = textDecoder.decode( result , {stream: false});
Z
zengyawen 已提交
215 216 217 218 219
  console.log("retStr = " + retStr);
  ```


## TextEncoder
Z
zengyawen 已提交
220

Z
zengyawen 已提交
221
### 属性
Z
zengyawen 已提交
222

Z
zengyawen 已提交
223 224
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Utils.Lang。

Z
zengyawen 已提交
225 226 227
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| encoding | string | 是 | 否 | 编码格式,默认值是utf-8。 |
Z
zengyawen 已提交
228 229


Z
zengyawen 已提交
230 231 232 233 234 235
### constructor

constructor()

TextEncoder的构造函数。

Z
zengyawen 已提交
236 237 238
**系统能力:** SystemCapability.Utils.Lang

**示例:**
Z
zengyawen 已提交
239 240 241 242 243 244 245
  ```
  var textEncoder = new util.TextEncoder();
  ```


### encode

X
xdmal 已提交
246
encode(input?: string): Uint8Array
Z
zengyawen 已提交
247 248 249

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

Z
zengyawen 已提交
250 251 252
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
253 254 255
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | input | string | 是 | 需要编码的字符串。 |
Z
zengyawen 已提交
256

Z
zengyawen 已提交
257
**返回值:**
Z
zengyawen 已提交
258 259 260 261
  | 类型 | 说明 |
  | -------- | -------- |
  | Uint8Array | 返回编码后的文本。 |

Z
zengyawen 已提交
262
**示例:**
Z
zengyawen 已提交
263 264 265 266 267
  ```
  var textEncoder = new util.TextEncoder();
  var result = new Uint8Array(buffer);
  result = textEncoder.encode("\uD800¥¥");
  ```
Z
zengyawen 已提交
268 269


Z
zengyawen 已提交
270 271
### encodeInto

X
xdmal 已提交
272
encodeInto(input: string, dest: Uint8Array, ): { read: number; written: number }
Z
zengyawen 已提交
273 274

放置生成的UTF-8编码文本。
Z
zengyawen 已提交
275

Z
zengyawen 已提交
276 277 278
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
279 280 281 282 283
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | input | string | 是 | 需要编码的字符串。 |
  | dest | Uint8Array | 是 | Uint8Array对象实例,用于将生成的UTF-8编码文本放入其中。 |

Z
zengyawen 已提交
284
**返回值:**
Z
zengyawen 已提交
285 286 287 288
  | 类型 | 说明 |
  | -------- | -------- |
  | Uint8Array | 返回编码后的文本。 |

Z
zengyawen 已提交
289
**示例:**
Z
zengyawen 已提交
290 291 292 293 294 295
  ```
  var that = new util.TextEncoder();
  var buffer = new ArrayBuffer(4);
  this.dest = new Uint8Array(buffer);
  var result = that.encodeInto("abcd", this.dest);
  ```
Z
zengyawen 已提交
296 297 298 299 300 301

## RationalNumber<sup>8+</sup>


### constructor<sup>8+</sup>

X
xdmal 已提交
302
constructor(numerator: number,denominator: number)
Z
zengyawen 已提交
303 304 305

RationalNumber的构造函数。

Z
zengyawen 已提交
306 307 308
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
309 310 311 312 313
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | numerator | number | 是 | 分子,整数类型。 |
  | denominator | number | 是 | 分母,整数类型。 |

Z
zengyawen 已提交
314
**示例:**
Z
zengyawen 已提交
315
  ```
Z
zengyawen 已提交
316
  var rationalNumber = new util.RationalNumber(1,2);
Z
zengyawen 已提交
317 318 319 320 321
  ```


### createRationalFromString<sup>8+</sup>

X
xdmal 已提交
322
static createRationalFromString​(rationalString: string): RationalNumber​
Z
zengyawen 已提交
323 324 325

基于给定的字符串创建一个RationalNumber对象。

Z
zengyawen 已提交
326 327 328
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
329 330 331 332
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | rationalString | string | 是 | 字符串格式。 |

Z
zengyawen 已提交
333
**返回值:**
Z
zengyawen 已提交
334 335 336 337
  | 类型 | 说明 |
  | -------- | -------- |
  | object | 返回有理数类的对象。 |

Z
zengyawen 已提交
338
**示例:**
Z
zengyawen 已提交
339 340 341 342 343 344 345 346
  ```
  var rationalNumber = new util.RationalNumber(1,2);
  var rational = rationalNumer.creatRationalFromString("3/4");
  ```


### compareTo<sup>8+</sup>

X
xdmal 已提交
347
compareTo​(another: RationalNumber): number​
Z
zengyawen 已提交
348 349 350

将当前的RationalNumber对象与给定的对象进行比较。

Z
zengyawen 已提交
351 352 353
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
354 355 356 357
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | another | RationalNumber | 是 | 其他的有理数对象。 |

Z
zengyawen 已提交
358
**返回值:**
Z
zengyawen 已提交
359 360 361 362
  | 类型 | 说明 |
  | -------- | -------- |
  | number | 如果两个对象相等,则返回0;如果给定对象小于当前对象,则返回1;如果给定对象大于当前对象,则返回-1。 |

Z
zengyawen 已提交
363
**示例:**
Z
zengyawen 已提交
364 365 366 367 368 369 370 371 372
  ```
  var rationalNumber = new util.RationalNumber(1,2);
  var rational = rationalNumer.creatRationalFromString("3/4");
  var result = rationalNumber.compareTo(rational);
  ```


### valueOf<sup>8+</sup>

X
xdmal 已提交
373
valueOf(): number
Z
zengyawen 已提交
374 375 376

以整数形式或者浮点数的形式获取当前RationalNumber对象的值。

Z
zengyawen 已提交
377 378 379
**系统能力:** SystemCapability.Utils.Lang

**返回值:**
Z
zengyawen 已提交
380 381 382 383
  | 类型 | 说明 |
  | -------- | -------- |
  | number | 返回整数或者浮点数的值。 |

Z
zengyawen 已提交
384
**示例:**
Z
zengyawen 已提交
385 386 387 388 389 390 391 392
  ```
  var rationalNumber = new util.RationalNumber(1,2);
  var result = rationalNumber.valueOf();
  ```


### equals<sup>8+</sup>

X
xdmal 已提交
393
equals​(obj: Object): boolean
Z
zengyawen 已提交
394 395 396

将当前的RationalNumber对象与给定的对象进行比较是否相等。

Z
zengyawen 已提交
397 398 399
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
400 401 402 403
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | object | Object | 是 | 其他类型对象。 |

Z
zengyawen 已提交
404
**返回值:**
Z
zengyawen 已提交
405 406 407 408
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 如果给定对象与当前对象相同,则返回true;否则返回false。 |

Z
zengyawen 已提交
409
**示例:**
Z
zengyawen 已提交
410 411 412 413 414 415 416 417 418
  ```
  var rationalNumber = new util.RationalNumber(1,2);
  var rational = rationalNumer.creatRationalFromString("3/4");
  var result = rationalNumber.equals(rational);
  ```


### getCommonDivisor<sup>8+</sup>

X
xdmal 已提交
419
static getCommonDivisor​(number1: number,number2: number): number
Z
zengyawen 已提交
420 421 422

获取两个指定整数的最大公约数。

Z
zengyawen 已提交
423 424 425
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
426 427 428 429 430
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | number1 | number | 是 | 整数类型。 |
  | number2 | number | 是 | 整数类型。 |

Z
zengyawen 已提交
431
**返回值:**
Z
zengyawen 已提交
432 433 434 435
  | 类型 | 说明 |
  | -------- | -------- |
  | number | 返回两个给定数字的最大公约数。 |

Z
zengyawen 已提交
436
**示例:**
Z
zengyawen 已提交
437 438 439 440 441 442 443 444
  ```
  var rationalNumber = new util.RationalNumber(1,2);
  var result = rationalNumber.getCommonDivisor(4,6);
  ```


### getNumerator<sup>8+</sup>

X
xdmal 已提交
445
getNumerator​(): number
Z
zengyawen 已提交
446 447 448

获取当前RationalNumber对象的分子。

Z
zengyawen 已提交
449 450 451 452
**系统能力:** SystemCapability.Utils.Lang

**返回值:**

Z
zengyawen 已提交
453 454 455 456
  | 类型 | 说明 |
  | -------- | -------- |
  | number | 返回RationalNumber对象的分子的值。 |

Z
zengyawen 已提交
457
**示例:**
Z
zengyawen 已提交
458 459 460 461 462 463 464 465
  ```
  var rationalNumber = new util.RationalNumber(1,2);
  var result = rationalNumber.getNumerator();
  ```


### getDenominator<sup>8+</sup>

X
xdmal 已提交
466
getDenominator​(): number
Z
zengyawen 已提交
467 468 469

获取当前RationalNumber对象的分母。

Z
zengyawen 已提交
470 471 472
**系统能力:** SystemCapability.Utils.Lang

**返回值:**
Z
zengyawen 已提交
473 474 475 476
  | 类型 | 说明 |
  | -------- | -------- |
  | number | 返回RationalNumber对象的分母的值。 |

Z
zengyawen 已提交
477
**示例:**
Z
zengyawen 已提交
478 479 480 481 482 483 484 485 486 487 488 489
  ```
  var rationalNumber = new util.RationalNumber(1,2);
  var result = rationalNumber.getDenominator();
  ```


### isZero<sup>8+</sup>

isZero​():boolean

检查当前RationalNumber对象是否为0。

Z
zengyawen 已提交
490 491 492
**系统能力:** SystemCapability.Utils.Lang

**返回值:**
Z
zengyawen 已提交
493 494 495 496
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 如果当前对象表示的值为0,则返回true;否则返回false。 |

Z
zengyawen 已提交
497
**示例:**
Z
zengyawen 已提交
498 499 500 501 502 503 504 505
  ```
  var rationalNumber = new util.RationalNumber(1,2);
  var result = rationalNumber.isZero();
  ```


### isNaN<sup>8+</sup>

X
xdmal 已提交
506
isNaN​(): boolean
Z
zengyawen 已提交
507 508 509

检查当前RationalNumber对象是否表示非数字(NaN)值。

Z
zengyawen 已提交
510 511 512
**系统能力:** SystemCapability.Utils.Lang

**返回值:**
Z
zengyawen 已提交
513 514 515 516
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 如果分母和分子都为0,则返回true;否则返回false。 |

Z
zengyawen 已提交
517
**示例:**
Z
zengyawen 已提交
518 519 520 521 522 523 524 525 526 527 528 529
  ```
  var rationalNumber = new util.RationalNumber(1,2);
  var result = rationalNumber.isNaN();
  ```


### isFinite<sup>8+</sup>

isFinite​():boolean

检查当前RationalNumber对象是否表示一个有限值。

Z
zengyawen 已提交
530 531 532
**系统能力:** SystemCapability.Utils.Lang

**返回值:**
Z
zengyawen 已提交
533 534 535 536
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 如果分母不为0,则返回true;否则返回false。 |

Z
zengyawen 已提交
537
**示例:**
Z
zengyawen 已提交
538 539 540 541 542 543 544 545
  ```
  var rationalNumber = new util.RationalNumber(1,2);
  var result = rationalNumber.isFinite();
  ```


### toString<sup>8+</sup>

X
xdmal 已提交
546
toString​(): string
Z
zengyawen 已提交
547 548 549

获取当前RationalNumber对象的字符串表示形式。

Z
zengyawen 已提交
550 551 552
**系统能力:** SystemCapability.Utils.Lang

**返回值:**
Z
zengyawen 已提交
553 554 555 556
  | 类型 | 说明 |
  | -------- | -------- |
  | string | 返回Numerator/Denominator格式的字符串,例如3/5,如果当前对象的分子和分母都为0,则返回NaN。 |

Z
zengyawen 已提交
557
**示例:**
Z
zengyawen 已提交
558 559 560 561 562 563 564 565 566
  ```
  var rationalNumber = new util.RationalNumber(1,2);
  var result = rationalNumber.toString();
  ```

## LruBuffer<sup>8+</sup>

### 属性

Z
zengyawen 已提交
567 568
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Utils.Lang。

Z
zengyawen 已提交
569 570 571 572
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| length | number | 是 | 否 | 当前缓冲区中值的总数。 |

Z
zengyawen 已提交
573
**示例:**
Z
zengyawen 已提交
574 575 576 577 578 579 580 581 582 583
  ```
  var pro = new util.LruBuffer();
  pro.put(2,10);
  pro.put(1,8);
  var result = pro.length;
  ```


### constructor<sup>8+</sup>

X
xdmal 已提交
584
constructor(capacity?: number)
Z
zengyawen 已提交
585 586 587

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

Z
zengyawen 已提交
588 589 590
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
591 592 593 594
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | capacity | number | 否 | 指示要为缓冲区自定义的容量。 |

Z
zengyawen 已提交
595
**示例:**
Z
zengyawen 已提交
596
  ```
Z
zengyawen 已提交
597
  var lrubuffer= new util.LruBuffer();
Z
zengyawen 已提交
598 599 600 601 602
  ```


### updateCapacity<sup>8+</sup>

X
xdmal 已提交
603
updateCapacity(newCapacity: number): void
Z
zengyawen 已提交
604 605 606

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

Z
zengyawen 已提交
607 608 609
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
610 611 612 613
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | newCapacity | number | 是 | 指示要为缓冲区自定义的容量。 |

Z
zengyawen 已提交
614
**示例:**
Z
zengyawen 已提交
615 616 617 618 619 620 621 622
  ```
  var pro = new util.LruBuffer();
  var result = pro.updateCapacity(100);
  ```


### toString<sup>8+</sup>

X
xdmal 已提交
623
toString(): string
Z
zengyawen 已提交
624 625 626

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

Z
zengyawen 已提交
627 628 629
**系统能力:** SystemCapability.Utils.Lang

**返回值:**
Z
zengyawen 已提交
630 631 632 633
  | 类型 | 说明 |
  | -------- | -------- |
  | string | 返回对象的字符串表示形式。 |

Z
zengyawen 已提交
634
**示例:**
Z
zengyawen 已提交
635 636 637 638 639 640 641 642 643 644 645
  ```
  var pro = new util.LruBuffer();
  pro.put(2,10);
  pro.get(2);
  pro.remove(20);
  var result = pro.toString();
  ```


### getCapacity<sup>8+</sup>

X
xdmal 已提交
646
getCapacity(): number
Z
zengyawen 已提交
647 648 649

获取当前缓冲区的容量。

Z
zengyawen 已提交
650 651 652
**系统能力:** SystemCapability.Utils.Lang

**返回值:**
Z
zengyawen 已提交
653 654 655 656
  | 类型 | 说明 |
  | -------- | -------- |
  | number | 返回当前缓冲区的容量。 |

Z
zengyawen 已提交
657
**示例:**
Z
zengyawen 已提交
658 659 660 661 662 663 664 665
  ```
  var pro = new util.LruBuffer();
  var result = pro.getCapacity();
  ```


### clear<sup>8+</sup>

X
xdmal 已提交
666
clear(): void
Z
zengyawen 已提交
667 668 669

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

Z
zengyawen 已提交
670 671 672
**系统能力:** SystemCapability.Utils.Lang

**示例:**
Z
zengyawen 已提交
673 674 675 676 677 678 679 680 681 682
  ```
  var pro = new util.LruBuffer();
  pro.put(2,10);
  var result = pro.size();
  pro.clear();
  ```


### getCreateCount<sup>8+</sup>

X
xdmal 已提交
683
getCreateCount(): number
Z
zengyawen 已提交
684 685 686

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

Z
zengyawen 已提交
687 688 689
**系统能力:** SystemCapability.Utils.Lang

**返回值:**
Z
zengyawen 已提交
690 691 692 693
  | 类型 | 说明 |
  | -------- | -------- |
  | number | 返回createDefault()返回值的次数。 |

Z
zengyawen 已提交
694
**示例:**
Z
zengyawen 已提交
695 696 697 698 699 700 701 702 703
  ```
  var pro = new util.LruBuffer();
  pro.put(1,8);
  var result = pro.getCreateCount();
  ```


### getMissCount<sup>8+</sup>

X
xdmal 已提交
704
getMissCount(): number
Z
zengyawen 已提交
705 706 707

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

Z
zengyawen 已提交
708 709 710
**系统能力:** SystemCapability.Utils.Lang

**返回值:**
Z
zengyawen 已提交
711 712 713 714
  | 类型 | 说明 |
  | -------- | -------- |
  | number | 返回查询值不匹配的次数。 |

Z
zengyawen 已提交
715
**示例:**
Z
zengyawen 已提交
716 717 718
  ```
  var pro = new util.LruBuffer();
  pro.put(2,10);
Z
zengyawen 已提交
719
  pro.get(2);
Z
zengyawen 已提交
720 721 722 723 724 725
  var result = pro.getMissCount();
  ```


### getRemovalCount<sup>8+</sup>

X
xdmal 已提交
726
getRemovalCount(): number
Z
zengyawen 已提交
727 728 729

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

Z
zengyawen 已提交
730 731 732
**系统能力:** SystemCapability.Utils.Lang

**返回值:**
Z
zengyawen 已提交
733 734 735 736
  | 类型 | 说明 |
  | -------- | -------- |
  | number | 返回从缓冲区中驱逐的次数。 |

Z
zengyawen 已提交
737
**示例:**
Z
zengyawen 已提交
738 739 740 741 742 743 744 745 746 747 748
  ```
  var pro = new util.LruBuffer();
  pro.put(2,10);
  pro.updateCapacity(2);
  pro.put(50,22);
  var result = pro.getRemovalCount();
  ```


### getMatchCount<sup>8+</sup>

X
xdmal 已提交
749
getMatchCount(): number
Z
zengyawen 已提交
750 751 752

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

Z
zengyawen 已提交
753 754 755
**系统能力:** SystemCapability.Utils.Lang

**返回值:**
Z
zengyawen 已提交
756 757 758 759
  | 类型 | 说明 |
  | -------- | -------- |
  | number | 返回查询值匹配成功的次数。 |

Z
zengyawen 已提交
760
**示例:**
Z
zengyawen 已提交
761 762 763 764 765 766 767 768 769 770
  ```
  var pro = new util.LruBuffer();
  pro.put(2,10);
  pro.get(2);
  var result = pro.getMatchCount();
  ```


### getPutCount<sup>8+</sup>

X
xdmal 已提交
771
getPutCount(): number
Z
zengyawen 已提交
772 773 774

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

Z
zengyawen 已提交
775 776 777
**系统能力:** SystemCapability.Utils.Lang

**返回值:**
Z
zengyawen 已提交
778 779 780 781
  | 类型 | 说明 |
  | -------- | -------- |
  | number | 返回将值添加到缓冲区的次数。 |

Z
zengyawen 已提交
782
**示例:**
Z
zengyawen 已提交
783 784 785 786 787 788 789 790 791
  ```
  var pro = new util.LruBuffer();
  pro.put(2,10);
  var result = pro.getPutCount();
  ```


### isEmpty<sup>8+</sup>

X
xdmal 已提交
792
isEmpty(): boolean
Z
zengyawen 已提交
793 794 795

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

Z
zengyawen 已提交
796 797 798
**系统能力:** SystemCapability.Utils.Lang

**返回值:**
Z
zengyawen 已提交
799 800 801 802
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 如果当前缓冲区不包含任何值,则返回true。 |

Z
zengyawen 已提交
803
**示例:**
Z
zengyawen 已提交
804 805 806 807 808 809 810 811 812
  ```
  var pro = new util.LruBuffer();
  pro.put(2,10);
  var result = pro.isEmpty();
  ```


### get<sup>8+</sup>

X
xdmal 已提交
813
get(key: K): V | undefined
Z
zengyawen 已提交
814 815 816

表示要查询的键。

Z
zengyawen 已提交
817 818 819
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
820 821 822 823
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | key | K | 是 | 要查询的键。 |

Z
zengyawen 已提交
824
**返回值:**
Z
zengyawen 已提交
825 826 827 828
  | 类型 | 说明 |
  | -------- | -------- |
  | V&nbsp;\|&nbsp;undefind | 如果指定的键存在于缓冲区中,则返回与键关联的值;否则返回undefined。 |

Z
zengyawen 已提交
829
**示例:**
Z
zengyawen 已提交
830 831 832 833 834 835 836 837 838
  ```
  var pro = new util.LruBuffer();
  pro.put(2,10);
  var result  = pro.get(2);
  ```


### put<sup>8+</sup>

X
xdmal 已提交
839
put(key: K,value: V): V
Z
zengyawen 已提交
840 841 842

将键值对添加到缓冲区。

Z
zengyawen 已提交
843 844 845
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
846 847 848 849 850
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | key | K | 是 | 要添加的密钥。 |
  | value | V | 是 | 指示与要添加的键关联的值。 |

Z
zengyawen 已提交
851
**返回值:**
Z
zengyawen 已提交
852 853 854 855
  | 类型 | 说明 |
  | -------- | -------- |
  | V | 返回与添加的键关联的值;如果要添加的键已经存在,则返回原始值,如果键或值为空,则抛出此异常。 |

Z
zengyawen 已提交
856
**示例:**
Z
zengyawen 已提交
857 858 859 860 861 862 863 864
  ```
  var pro = new util.LruBuffer();
  var result = pro.put(2,10);
  ```


### values<sup>8+</sup>

X
xdmal 已提交
865
values(): V[]
Z
zengyawen 已提交
866 867 868

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

Z
zengyawen 已提交
869 870 871
**系统能力:** SystemCapability.Utils.Lang

**返回值:**
Z
zengyawen 已提交
872 873 874 875
  | 类型 | 说明 |
  | -------- | -------- |
  | V&nbsp;[] | 按从最近访问到最近最少访问的顺序返回当前缓冲区中所有值的列表。 |

Z
zengyawen 已提交
876
**示例:**
Z
zengyawen 已提交
877 878 879 880 881 882 883 884 885 886 887
  ```
  var pro = new util.LruBuffer();
  pro.put(2,10);
  pro.put(2,"anhu");
  pro.put("afaf","grfb");
  var result = pro.values();
  ```


### keys<sup>8+</sup>

X
xdmal 已提交
888
keys(): K[]
Z
zengyawen 已提交
889 890 891

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

Z
zengyawen 已提交
892 893 894
**系统能力:** SystemCapability.Utils.Lang

**返回值:**
Z
zengyawen 已提交
895 896 897 898
  | 类型 | 说明 |
  | -------- | -------- |
  | K&nbsp;[] | 按升序返回当前缓冲区中所有键的列表,从最近访问到最近最少访问。 |

Z
zengyawen 已提交
899
**示例:**
Z
zengyawen 已提交
900 901 902 903 904 905 906 907 908
  ```
  var pro = new util.LruBuffer();
  pro.put(2,10);
  var result = pro.keys();
  ```


### remove<sup>8+</sup>

X
xdmal 已提交
909
remove(key: K): V | undefined
Z
zengyawen 已提交
910 911 912

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

Z
zengyawen 已提交
913 914 915
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
916 917 918 919
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | key | K | 是 | 要删除的密钥。 |

Z
zengyawen 已提交
920
**返回值:**
Z
zengyawen 已提交
921 922 923 924
  | 类型 | 说明 |
  | -------- | -------- |
  | V&nbsp;\|&nbsp;undefind | 返回一个包含已删除键值对的Optional对象;如果key不存在,则返回一个空的Optional对象,如果key为null,则抛出异常。 |

Z
zengyawen 已提交
925
**示例:**
Z
zengyawen 已提交
926 927 928 929 930 931 932 933 934
  ```
  var pro = new util.LruBuffer();
  pro.put(2,10);
  var result = pro.remove(20);
  ```


### afterRemoval<sup>8+</sup>

X
xdmal 已提交
935
afterRemoval(isEvict: boolean,key: K,value: V,newValue: V): void
Z
zengyawen 已提交
936 937 938

删除值后执行后续操作。

Z
zengyawen 已提交
939 940 941
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
942 943 944 945 946 947 948
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | isEvict | boolean | 否 | 因容量不足而调用该方法时,参数值为true,其他情况为false。 |
  | key | K | 是 | 表示删除的键。 |
  | value | V | 是 | 表示删除的值。 |
  | newValue | V | 否 | 如果已调用put方法并且要添加的键已经存在,则参数值是关联的新值。其他情况下参数值为空。 |

Z
zengyawen 已提交
949
**示例:**
Z
zengyawen 已提交
950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973
  ```
  var arr = [];
  class ChildLruBuffer extends util.LruBuffer
  {
  	constructor()
  	{
  		super();
  	}
  	static getInstance()
  	{
  		if(this.instance ==  null)
  		{
  			this.instance = new ChildLruBuffer();
  		}
  		return this.instance;  
  	}
  	afterRemoval(isEvict, key, value, newValue)
  	{
  		if (isEvict === false)
  		{
  			arr = [key, value, newValue];
  		}
  	}
  }
Z
zengyawen 已提交
974
  ChildLruBuffer.getInstance().afterRemoval(false,10,30,null);
Z
zengyawen 已提交
975 976 977 978 979
  ```


### contains<sup>8+</sup>

X
xdmal 已提交
980
contains(key: K): boolean
Z
zengyawen 已提交
981 982 983

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

Z
zengyawen 已提交
984 985 986
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
987 988 989 990
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | key | K | 是 | 表示要检查的键。 |

Z
zengyawen 已提交
991
**返回值:**
Z
zengyawen 已提交
992 993 994 995
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 如果缓冲区包含指定的键,则返回&nbsp;true。 |

Z
zengyawen 已提交
996
**示例:**
Z
zengyawen 已提交
997 998 999 1000 1001 1002 1003 1004 1005
  ```
  var pro = new util.LruBuffer();
  pro.put(2,10);
  var result = pro.contains(20);
  ```


### createDefault<sup>8+</sup>

X
xdmal 已提交
1006
createDefault(key: K): V
Z
zengyawen 已提交
1007 1008 1009

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

Z
zengyawen 已提交
1010 1011 1012
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
1013 1014 1015 1016
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | key | K | 是 | 表示丢失的键。 |

Z
zengyawen 已提交
1017
**返回值:**
Z
zengyawen 已提交
1018 1019 1020 1021
  | 类型 | 说明 |
  | -------- | -------- |
  | V | 返回与键关联的值。 |

Z
zengyawen 已提交
1022
**示例:**
Z
zengyawen 已提交
1023 1024 1025 1026 1027 1028 1029 1030
  ```
  var pro = new util.LruBuffer();
  var result = pro.createDefault(50);
  ```


### entries<sup>8+</sup>

X
xdmal 已提交
1031
entries(): IterableIterator&lt;[K,V]&gt;
Z
zengyawen 已提交
1032 1033 1034

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

Z
zengyawen 已提交
1035 1036 1037
**系统能力:** SystemCapability.Utils.Lang

**返回值:**
Z
zengyawen 已提交
1038 1039 1040 1041
  | 类型 | 说明 |
  | -------- | -------- |
  | [K,&nbsp;V] | 返回一个可迭代数组。 |

Z
zengyawen 已提交
1042
**示例:**
Z
zengyawen 已提交
1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055
  ```
  var pro = new util.LruBuffer();
  pro.put(2,10);
  var result = pro.entries();
  ```


### [Symbol.iterator]<sup>8+</sup>

[Symbol.iterator]\(): IterableIterator&lt;[K, V]&gt;

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

Z
zengyawen 已提交
1056 1057 1058
**系统能力:** SystemCapability.Utils.Lang

**返回值:**
Z
zengyawen 已提交
1059 1060 1061 1062
  | 类型 | 说明 |
  | -------- | -------- |
  | [K,&nbsp;V] | 返回一个键值对形式的二维数组。 |

Z
zengyawen 已提交
1063
**示例:**
Z
zengyawen 已提交
1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080
  ```
  var pro = new util.LruBuffer();
  pro.put(2,10);
  var result = pro[symbol.iterator]();
  ```


## Scope<sup>8+</sup>


### ScopeType<sup>8+</sup>

用于表示范围中的值的类型。该类型的值,类型可以为ScopeComparable或number。

ScopeComparable类型的值需要实现compareTo方法,确保传入的数据具有可比性。
```
interface ScopeComparable{
X
xdmal 已提交
1081
    compareTo(other: ScopeComparable): boolean;
Z
zengyawen 已提交
1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110
}
type ScopeType = ScopeComparable | number;
```


构造新类,实现compareTo方法。后续示例代码中,均通过Temperature,获取[ScopeType](#scopetype8)的实例化对象。


示例:
```
class Temperature{
    constructor(value){
       this._temp = value;
    }
    comapreTo(value){
       return this._temp >= value.getTemp();
    }
    getTemp(){
       return this._temp;
    }
    toString(){
       return this._temp.toString();
    }
}
```


### constructor<sup>8+</sup>

X
xdmal 已提交
1111
constructor(lowerObj: ScopeType, upperObj: ScopeType)
Z
zengyawen 已提交
1112 1113 1114

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

Z
zengyawen 已提交
1115 1116 1117
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
1118 1119 1120 1121 1122
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | lowerObj | [ScopeType](#scopetype8) | 是 | 指定作用域实例的下限。 |
  | upperObj | [ScopeType](#scopetype8) | 是 | 指定作用域实例的上限。 |

Z
zengyawen 已提交
1123
**示例:**
Z
zengyawen 已提交
1124 1125 1126 1127 1128 1129 1130 1131 1132
  ```
  var tempLower = new Temperature(30);
  var tempUpper = new Temperature(40);
  var range = new util.Scope(tempLower, tempUpper);
  ```


### toString<sup>8+</sup>

X
xdmal 已提交
1133
toString(): string
Z
zengyawen 已提交
1134 1135 1136

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

Z
zengyawen 已提交
1137 1138 1139
**系统能力:** SystemCapability.Utils.Lang

**返回值:**
Z
zengyawen 已提交
1140 1141 1142 1143
  | 类型 | 说明 |
  | -------- | -------- |
  | string | 返回包含当前范围对象的字符串表示形式。 |

Z
zengyawen 已提交
1144
**示例:**
Z
zengyawen 已提交
1145 1146 1147 1148 1149 1150 1151 1152 1153 1154
  ```
  var tempLower = new Temperature(30);
  var tempUpper = new Temperature(40);
  var range = new util.Scope(tempLower, tempUpper);
  var result = range.toString();
  ```


### intersect<sup>8+</sup>

X
xdmal 已提交
1155
intersect(range: Scope): Scope
Z
zengyawen 已提交
1156 1157 1158

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

Z
zengyawen 已提交
1159 1160 1161
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
1162 1163 1164 1165
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | range | [Scope](#scope8) | 是 | 传入一个给定范围。 |

Z
zengyawen 已提交
1166
**返回值:**
Z
zengyawen 已提交
1167 1168 1169 1170
  | 类型 | 说明 |
  | -------- | -------- |
  | [Scope](#scope8) | 返回给定范围和当前范围的交集。 |

Z
zengyawen 已提交
1171
**示例:**
Z
zengyawen 已提交
1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188
  ```
  var tempLower = new Temperature(30);
  var tempUpper = new Temperature(40);
  var range = new util.Scope(tempLower, tempUpper);
  var tempMiDF = new Temperature(35);
  var tempMidS = new Temperature(39);
  var rangeFir = new util.Scope(tempMiDF, tempMidS);
  range.intersect(rangeFir );
  ```


### intersect<sup>8+</sup>

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

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

Z
zengyawen 已提交
1189 1190 1191
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
1192 1193 1194 1195 1196
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | lowerObj | [ScopeType](#scopetype8) | 是 | 给定范围的下限。 |
  | upperObj | [ScopeType](#scopetype8) | 是 | 给定范围的上限。 |

Z
zengyawen 已提交
1197
**返回值:**
Z
zengyawen 已提交
1198 1199 1200 1201
  | 类型 | 说明 |
  | -------- | -------- |
  | [Scope](#scope8) | 返回当前范围与给定下限和上限范围的交集。 |

Z
zengyawen 已提交
1202
**示例:**
Z
zengyawen 已提交
1203 1204 1205 1206 1207 1208
  ```
  var tempLower = new Temperature(30);
  var tempUpper = new Temperature(40);
  var tempMiDF = new Temperature(35);
  var tempMidS = new Temperature(39);
  var range = new util.Scope(tempLower, tempUpper);
Z
zengyawen 已提交
1209
  var result = range.intersect(tempMiDF, tempMidS);
Z
zengyawen 已提交
1210 1211 1212 1213 1214
  ```


### getUpper<sup>8+</sup>

X
xdmal 已提交
1215
getUpper(): ScopeType
Z
zengyawen 已提交
1216 1217 1218

获取当前范围的上限。

Z
zengyawen 已提交
1219 1220 1221 1222
**系统能力:** SystemCapability.Utils.Lang

**返回值:**

Z
zengyawen 已提交
1223 1224 1225 1226
  | 类型 | 说明 |
  | -------- | -------- |
  | [ScopeType](#scopetype8) | 返回当前范围的上限值。 |

Z
zengyawen 已提交
1227
**示例:**
Z
zengyawen 已提交
1228 1229 1230 1231
  ```
  var tempLower = new Temperature(30);
  var tempUpper = new Temperature(40);
  var range = new util.Scope(tempLower, tempUpper);
Z
zengyawen 已提交
1232
  var result = range.getUpper();
Z
zengyawen 已提交
1233 1234 1235 1236 1237
  ```


### getLower<sup>8+</sup>

X
xdmal 已提交
1238
getLower(): ScopeType
Z
zengyawen 已提交
1239 1240 1241

获取当前范围的下限。

Z
zengyawen 已提交
1242 1243 1244
**系统能力:** SystemCapability.Utils.Lang

**返回值:**
Z
zengyawen 已提交
1245 1246 1247 1248
  | 类型 | 说明 |
  | -------- | -------- |
  | [ScopeType](#scopetype8) | 返回当前范围的下限值。 |

Z
zengyawen 已提交
1249
**示例:**
Z
zengyawen 已提交
1250 1251 1252 1253
  ```
  var tempLower = new Temperature(30);
  var tempUpper = new Temperature(40);
  var range = new util.Scope(tempLower, tempUpper);
Z
zengyawen 已提交
1254
  var result = range.getLower();
Z
zengyawen 已提交
1255 1256 1257 1258 1259
  ```


### expand<sup>8+</sup>

X
xdmal 已提交
1260
expand(lowerObj: ScopeType,upperObj: ScopeType): Scope
Z
zengyawen 已提交
1261 1262 1263

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

Z
zengyawen 已提交
1264 1265 1266
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
1267 1268 1269 1270 1271
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | lowerObj | [ScopeType](#scopetype8) | 是 | 给定范围的下限。 |
  | upperObj | [ScopeType](#scopetype8) | 是 | 给定范围的上限。 |

Z
zengyawen 已提交
1272
**返回值:**
Z
zengyawen 已提交
1273 1274 1275 1276
  | 类型 | 说明 |
  | -------- | -------- |
  | [Scope](#scope8) | 返回当前范围和给定下限和上限的并集。 |

Z
zengyawen 已提交
1277
**示例:**
Z
zengyawen 已提交
1278 1279 1280 1281 1282 1283
  ```
  var tempLower = new Temperature(30);
  var tempUpper = new Temperature(40);
  var tempMiDF = new Temperature(35);
  var tempMidS = new Temperature(39);
  var range = new util.Scope(tempLower, tempUpper);
Z
zengyawen 已提交
1284
  var result = range.expand(tempMiDF, tempMidS);
Z
zengyawen 已提交
1285 1286 1287 1288 1289
  ```


### expand<sup>8+</sup>

X
xdmal 已提交
1290
expand(range: Scope): Scope
Z
zengyawen 已提交
1291 1292 1293

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

Z
zengyawen 已提交
1294 1295 1296
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
1297 1298 1299 1300
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | range | [Scope](#scope8) | 是 | 传入一个给定范围。 |

Z
zengyawen 已提交
1301
**返回值:**
Z
zengyawen 已提交
1302 1303 1304 1305
  | 类型 | 说明 |
  | -------- | -------- |
  | [Scope](#scope8) | 返回包括当前范围和给定范围的并集。 |

Z
zengyawen 已提交
1306
**示例:**
Z
zengyawen 已提交
1307 1308 1309 1310 1311 1312 1313
  ```
  var tempLower = new Temperature(30);
  var tempUpper = new Temperature(40);
  var tempMiDF = new Temperature(35);
  var tempMidS = new Temperature(39);
  var range = new util.Scope(tempLower, tempUpper);
  var rangeFir = new util.Scope(tempMiDF, tempMidS);
Z
zengyawen 已提交
1314
  var result = range.expand(rangeFir);
Z
zengyawen 已提交
1315 1316 1317 1318 1319
  ```


### expand<sup>8+</sup>

X
xdmal 已提交
1320
expand(value: ScopeType): Scope
Z
zengyawen 已提交
1321 1322 1323

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

Z
zengyawen 已提交
1324 1325 1326
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
1327 1328 1329 1330
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | [ScopeType](#scopetype8) | 是 | 传入一个给定值。 |

Z
zengyawen 已提交
1331
**返回值:**
Z
zengyawen 已提交
1332 1333 1334 1335
  | 类型 | 说明 |
  | -------- | -------- |
  | [Scope](#scope8) | 返回包括当前范围和给定值的并集。 |

Z
zengyawen 已提交
1336
**示例:**
Z
zengyawen 已提交
1337 1338 1339 1340 1341
  ```
  var tempLower = new Temperature(30);
  var tempUpper = new Temperature(40);
  var tempMiDF = new Temperature(35);
  var range = new util.Scope(tempLower, tempUpper);
Z
zengyawen 已提交
1342
  var result = range.expand(tempMiDF);
Z
zengyawen 已提交
1343 1344 1345 1346 1347
  ```


### contains<sup>8+</sup>

X
xdmal 已提交
1348
contains(value: ScopeType): boolean
Z
zengyawen 已提交
1349 1350 1351

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

Z
zengyawen 已提交
1352 1353 1354
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
1355 1356 1357 1358
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | [ScopeType](#scopetype8) | 是 | 传入一个给定值。 |

Z
zengyawen 已提交
1359
**返回值:**
Z
zengyawen 已提交
1360 1361 1362 1363
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 如果给定值包含在当前范围内返回true,否则返回false。 |

Z
zengyawen 已提交
1364
**示例:**
Z
zengyawen 已提交
1365 1366 1367 1368 1369
  ```
  var tempLower = new Temperature(30);
  var tempUpper = new Temperature(40);
  var tempMiDF = new Temperature(35);
  var range = new util.Scope(tempLower, tempUpper);
Z
zengyawen 已提交
1370
  range.contains(tempMiDF);
Z
zengyawen 已提交
1371 1372 1373 1374 1375
  ```


### contains<sup>8+</sup>

X
xdmal 已提交
1376
contains(range: Scope): boolean
Z
zengyawen 已提交
1377 1378 1379

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

Z
zengyawen 已提交
1380 1381 1382
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
1383 1384 1385 1386
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | range | [Scope](#scope8) | 是 | 传入一个给定范围。 |

Z
zengyawen 已提交
1387
**返回值:**
Z
zengyawen 已提交
1388 1389 1390 1391
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 如果给定范围包含在当前范围内返回true,否则返回false。 |

Z
zengyawen 已提交
1392
**示例:**
Z
zengyawen 已提交
1393 1394 1395 1396 1397 1398 1399
  ```
  var tempLower = new Temperature(30);
  var tempUpper = new Temperature(40);
  var range = new util.Scope(tempLower, tempUpper);
  var tempLess = new Temperature(20);
  var tempMore = new Temperature(45);
  var rangeSec = new util.Scope(tempLess, tempMore);
Z
zengyawen 已提交
1400
  var result = range.contains(rangeSec);
Z
zengyawen 已提交
1401 1402 1403 1404 1405
  ```


### clamp<sup>8+</sup>

X
xdmal 已提交
1406
clamp(value: ScopeType): ScopeType
Z
zengyawen 已提交
1407 1408 1409

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

Z
zengyawen 已提交
1410 1411 1412
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
1413 1414 1415 1416
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | [ScopeType](#scopetype8) | 是 | 传入的给定值。 |

Z
zengyawen 已提交
1417
**返回值:**
Z
zengyawen 已提交
1418 1419
  | 类型 | 说明 |
  | -------- | -------- |
Z
zengyawen 已提交
1420
  | [ScopeType](#scopetype8) | 如果传入的value小于下限,则返回lowerObj;如果大于上限值则返回upperObj;如果在当前范围内,则返回value。 |
Z
zengyawen 已提交
1421

Z
zengyawen 已提交
1422
**示例:**
Z
zengyawen 已提交
1423 1424 1425 1426 1427
  ```
  var tempLower = new Temperature(30);
  var tempUpper = new Temperature(40);
  var tempMiDF = new Temperature(35);
  var range = new util.Scope(tempLower, tempUpper);
Z
zengyawen 已提交
1428
  var result = range.clamp(tempMiDF);
Z
zengyawen 已提交
1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440
  ```


## Base64<sup>8+</sup>


### constructor<sup>8+</sup>

constructor()

Base64的构造函数。

Z
zengyawen 已提交
1441 1442 1443
**系统能力:** SystemCapability.Utils.Lang

**示例:**
Z
zengyawen 已提交
1444
  ```
Z
zengyawen 已提交
1445
  var base64 = new  util.Base64();
Z
zengyawen 已提交
1446 1447 1448 1449 1450
  ```


### encodeSync<sup>8+</sup>

X
xdmal 已提交
1451
encodeSync(src: Uint8Array): Uint8Array
Z
zengyawen 已提交
1452 1453 1454

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

Z
zengyawen 已提交
1455 1456 1457
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
1458 1459 1460 1461
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | src | Uint8Array | 是 | 编码输入Uint8数组。 |

Z
zengyawen 已提交
1462
**返回值:**
Z
zengyawen 已提交
1463 1464 1465 1466
  | 类型 | 说明 |
  | -------- | -------- |
  | Uint8Array | 返回编码后新分配的Uint8数组。 |

Z
zengyawen 已提交
1467
**示例:**
Z
zengyawen 已提交
1468 1469 1470 1471 1472 1473 1474 1475 1476
  ```
  var that = new util.Base64();
  var array = new Uint8Array([115,49,51]);
  var result = that.encodeSync(array);
  ```


### encodeToStringSync<sup>8+</sup>

X
xdmal 已提交
1477
encodeToStringSync(src: Uint8Array): string
Z
zengyawen 已提交
1478 1479 1480

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

Z
zengyawen 已提交
1481 1482 1483
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
1484 1485 1486 1487
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | src | Uint8Array | 是 | 编码输入Uint8数组。 |

Z
zengyawen 已提交
1488
**返回值:**
Z
zengyawen 已提交
1489 1490 1491 1492
  | 类型 | 说明 |
  | -------- | -------- |
  | string | 返回编码后的字符串。 |

Z
zengyawen 已提交
1493
**示例:**
Z
zengyawen 已提交
1494 1495 1496 1497 1498 1499 1500 1501 1502
  ```
  var that = new util.Base64();
  var array = new Uint8Array([115,49,51]);
  var result = that.encodeToStringSync(array);
  ```


### decodeSync<sup>8+</sup>

X
xdmal 已提交
1503
decodeSync(src: Uint8Array | string): Uint8Array
Z
zengyawen 已提交
1504 1505 1506

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

Z
zengyawen 已提交
1507 1508 1509
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
1510 1511 1512 1513
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | src | Uint8Array&nbsp;\|&nbsp;string | 是 | 解码输入Uint8数组或者字符串。 |

Z
zengyawen 已提交
1514
**返回值:**
Z
zengyawen 已提交
1515 1516 1517 1518
  | 类型 | 说明 |
  | -------- | -------- |
  | Uint8Array | 返回解码后新分配的Uint8数组。 |

Z
zengyawen 已提交
1519
**示例:**
Z
zengyawen 已提交
1520 1521 1522 1523 1524 1525 1526 1527 1528
  ```
  var that = new util.Base64();
  var buff = 'czEz';
  var result = that.decodeSync(buff);
  ```


### encode<sup>8+</sup>

X
xdmal 已提交
1529
encode(src: Uint8Array): Promise&lt;Uint8Array&gt;
Z
zengyawen 已提交
1530 1531 1532

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

Z
zengyawen 已提交
1533 1534 1535
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
1536 1537 1538 1539
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | src | Uint8Array | 是 | 异步编码输入Uint8数组。 |

Z
zengyawen 已提交
1540
**返回值:**
Z
zengyawen 已提交
1541 1542 1543 1544
  | 类型 | 说明 |
  | -------- | -------- |
  | Promise&lt;Uint8Array&gt; | 返回异步编码后新分配的Uint8数组。 |

Z
zengyawen 已提交
1545
**示例:**
Z
zengyawen 已提交
1546 1547 1548 1549
  ```
  var that = new util.Base64();
  var array = new Uint8Array([115,49,51]);
  var rarray = new Uint8Array([99,122,69,122]);
Z
zengyawen 已提交
1550
  that.encode(array).then(val=>{    
Z
zengyawen 已提交
1551
      for (var i = 0; i < rarray.length; i++) {        
Z
zengyawen 已提交
1552
          console.log(val[i])
Z
zengyawen 已提交
1553 1554 1555 1556 1557 1558 1559
      }
  })
  ```


### encodeToString<sup>8+</sup>

X
xdmal 已提交
1560
encodeToString(src: Uint8Array): Promise&lt;string&gt;
Z
zengyawen 已提交
1561 1562 1563

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

Z
zengyawen 已提交
1564 1565 1566
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
1567 1568 1569 1570
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | src | Uint8Array | 是 | 异步编码输入Uint8数组。 |

Z
zengyawen 已提交
1571
**返回值:**
Z
zengyawen 已提交
1572 1573 1574 1575
  | 类型 | 说明 |
  | -------- | -------- |
  | Promise&lt;string&gt; | 返回异步编码后的字符串。 |

Z
zengyawen 已提交
1576
**示例:**
Z
zengyawen 已提交
1577 1578 1579
  ```
  var that = new util.Base64();
  var array = new Uint8Array([115,49,51]);
Z
zengyawen 已提交
1580
  that.encodeToString(array).then(val=>{    
Z
zengyawen 已提交
1581
      console.log(val)
Z
zengyawen 已提交
1582 1583 1584 1585 1586 1587
  })
  ```


### decode<sup>8+</sup>

X
xdmal 已提交
1588
decode(src: Uint8Array | string): Promise&lt;Uint8Array&gt;
Z
zengyawen 已提交
1589 1590 1591

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

Z
zengyawen 已提交
1592 1593 1594
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
1595 1596 1597 1598
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | src | Uint8Array&nbsp;\|&nbsp;string | 是 | 异步解码输入Uint8数组或者字符串。 |

Z
zengyawen 已提交
1599
**返回值:**
Z
zengyawen 已提交
1600 1601 1602 1603
  | 类型 | 说明 |
  | -------- | -------- |
  | Promise&lt;Uint8Array&gt; | 返回异步解码后新分配的Uint8数组。 |

Z
zengyawen 已提交
1604
**示例:**
Z
zengyawen 已提交
1605 1606 1607 1608
  ```
  var that = new util.Base64();
  var array = new Uint8Array([99,122,69,122]);
  var rarray = new Uint8Array([115,49,51]);
Z
zengyawen 已提交
1609
  that.decode(array).then(val=>{    
Z
zengyawen 已提交
1610
      for (var i = 0; i < rarray.length; i++) {        
Z
zengyawen 已提交
1611
          console.log(val[i])
Z
zengyawen 已提交
1612 1613 1614 1615 1616
      }
  })
  ```


1617
## types<sup>8+</sup>
Z
zengyawen 已提交
1618 1619 1620 1621 1622 1623 1624 1625


### constructor<sup>8+</sup>

constructor()

Types的构造函数。

Z
zengyawen 已提交
1626 1627 1628
**系统能力:** SystemCapability.Utils.Lang

**示例:**
Z
zengyawen 已提交
1629
  ```
1630
  var type = new util.types();
Z
zengyawen 已提交
1631 1632 1633 1634 1635
  ```


### isAnyArrayBuffer<sup>8+</sup>

X
xdmal 已提交
1636
isAnyArrayBuffer(value: Object): boolean
Z
zengyawen 已提交
1637 1638 1639

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

Z
zengyawen 已提交
1640 1641 1642
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
1643 1644 1645 1646
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | Object | 是 | 待检测对象。 |

Z
zengyawen 已提交
1647
**返回值:**
Z
zengyawen 已提交
1648 1649 1650 1651
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 判断的结果,如果是ArrayBuffer类型为true,反之为false。 |

Z
zengyawen 已提交
1652
**示例:**
Z
zengyawen 已提交
1653
  ```
1654
  var that = new util.types();
Z
zengyawen 已提交
1655 1656 1657 1658 1659 1660
  var result = that.isAnyArrayBuffer(new ArrayBuffer([]));
  ```


### isArrayBufferView<sup>8+</sup>

X
xdmal 已提交
1661
isArrayBufferView(value: Object): boolean
Z
zengyawen 已提交
1662 1663 1664

检查输入的value是否是内置ArrayBufferView辅助类型。

Z
zengyawen 已提交
1665
ArrayBufferView辅助类型包括:Int8Array、Int16Array、Int32Array、Uint8Array、Uint8ClampedArray、Uint32Array、Float32Array、Float64Array、DataView。
Z
zengyawen 已提交
1666

Z
zengyawen 已提交
1667 1668 1669
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
1670 1671 1672 1673
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | Object | 是 | 待检测对象。 |

Z
zengyawen 已提交
1674
**返回值:**
Z
zengyawen 已提交
1675 1676 1677 1678
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 判断的结果,如果是内置包含的ArrayBufferView辅助类型为true,反之为false。 |

Z
zengyawen 已提交
1679
**示例:**
Z
zengyawen 已提交
1680
  ```
1681
  var that = new util.types();
Z
zengyawen 已提交
1682 1683 1684 1685 1686 1687
  var result = that.isArrayBufferView(new Int8Array([]));
  ```


### isArgumentsObject<sup>8+</sup>

X
xdmal 已提交
1688
isArgumentsObject(value: Object): boolean
Z
zengyawen 已提交
1689 1690 1691

检查输入的value是否是一个arguments对象类型。

Z
zengyawen 已提交
1692 1693 1694
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
1695 1696 1697 1698
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | Object | 是 | 待检测对象。 |

Z
zengyawen 已提交
1699
**返回值:**
Z
zengyawen 已提交
1700 1701 1702 1703
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 判断的结果,如果是内置包含的arguments类型为true,反之为false。 |

Z
zengyawen 已提交
1704
**示例:**
Z
zengyawen 已提交
1705
  ```
1706
  var that = new util.types();
Z
zengyawen 已提交
1707 1708 1709 1710 1711 1712 1713 1714 1715
  function foo() {
      var result = that.isArgumentsObject(arguments);
  }
  var f = foo();
  ```


### isArrayBuffer<sup>8+</sup>

X
xdmal 已提交
1716
isArrayBuffer(value: Object): boolean
Z
zengyawen 已提交
1717

Z
zengyawen 已提交
1718
检查输入的value是否是ArrayBuffer类型。
Z
zengyawen 已提交
1719

Z
zengyawen 已提交
1720 1721 1722
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
1723 1724 1725 1726
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | Object | 是 | 待检测对象。 |

Z
zengyawen 已提交
1727
**返回值:**
Z
zengyawen 已提交
1728 1729 1730 1731
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 判断的结果,如果是内置包含的ArrayBuffer类型为true,反之为false。 |

Z
zengyawen 已提交
1732
**示例:**
Z
zengyawen 已提交
1733
  ```
1734
  var that = new util.types();
Z
zengyawen 已提交
1735 1736 1737 1738 1739 1740
  var result = that.isArrayBuffer(new ArrayBuffer([]));
  ```


### isAsyncFunction<sup>8+</sup>

X
xdmal 已提交
1741
isAsyncFunction(value: Object): boolean
Z
zengyawen 已提交
1742 1743 1744

检查输入的value是否是一个异步函数类型。

Z
zengyawen 已提交
1745 1746 1747
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
1748 1749 1750 1751
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | Object | 是 | 待检测对象。 |

Z
zengyawen 已提交
1752
**返回值:**
Z
zengyawen 已提交
1753 1754 1755 1756
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 判断的结果,如果是内置包含的异步函数类型为true,反之为false。 |

Z
zengyawen 已提交
1757
**示例:**
Z
zengyawen 已提交
1758
  ```
1759
  var that = new util.types();
Z
zengyawen 已提交
1760 1761 1762 1763 1764 1765
  var result = that.isAsyncFunction(async function foo() {});
  ```


### isBooleanObject<sup>8+</sup>

X
xdmal 已提交
1766
isBooleanObject(value: Object): boolean
Z
zengyawen 已提交
1767 1768 1769

检查输入的value是否是一个Boolean对象类型。

Z
zengyawen 已提交
1770 1771 1772
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
1773 1774 1775 1776
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | Object | 是 | 待检测对象。 |

Z
zengyawen 已提交
1777
**返回值:**
Z
zengyawen 已提交
1778 1779 1780 1781
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 判断的结果,如果是内置包含的Boolean对象类型为true,反之为false。 |

Z
zengyawen 已提交
1782
**示例:**
Z
zengyawen 已提交
1783
  ```
1784
  var that = new util.types();
Z
zengyawen 已提交
1785 1786 1787 1788 1789 1790
  var result = that.isBooleanObject(new Boolean(true));
  ```


### isBoxedPrimitive<sup>8+</sup>

X
xdmal 已提交
1791
isBoxedPrimitive(value: Object): boolean
Z
zengyawen 已提交
1792 1793 1794

检查输入的value是否是Boolean或Number或String或Symbol对象类型。

Z
zengyawen 已提交
1795 1796 1797
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
1798 1799 1800 1801
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | Object | 是 | 待检测对象。 |

Z
zengyawen 已提交
1802
**返回值:**
Z
zengyawen 已提交
1803 1804 1805 1806
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 判断的结果,如果是内置包含的Boolean或Number或String或Symbol对象类型为true,反之为false。 |

Z
zengyawen 已提交
1807
**示例:**
Z
zengyawen 已提交
1808
  ```
1809
  var that = new util.types();
Z
zengyawen 已提交
1810 1811 1812 1813 1814 1815
  var result = that.isBoxedPrimitive(new Boolean(false));
  ```


### isDataView<sup>8+</sup>

X
xdmal 已提交
1816
isDataView(value: Object): boolean
Z
zengyawen 已提交
1817 1818 1819

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

Z
zengyawen 已提交
1820 1821 1822
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
1823 1824 1825 1826
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | Object | 是 | 待检测对象。 |

Z
zengyawen 已提交
1827
**返回值:**
Z
zengyawen 已提交
1828 1829 1830 1831
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 判断的结果,如果是内置包含的DataView对象类型为true,反之为false。 |

Z
zengyawen 已提交
1832
**示例:**
Z
zengyawen 已提交
1833
  ```
1834
  var that = new util.types();
Z
zengyawen 已提交
1835 1836 1837 1838 1839 1840 1841
  const ab = new ArrayBuffer(20);
  var result = that.isDataView(new DataView(ab));
  ```


### isDate<sup>8+</sup>

X
xdmal 已提交
1842
isDate(value: Object): boolean
Z
zengyawen 已提交
1843 1844 1845

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

Z
zengyawen 已提交
1846 1847 1848
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
1849 1850 1851 1852
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | Object | 是 | 待检测对象。 |

Z
zengyawen 已提交
1853
**返回值:**
Z
zengyawen 已提交
1854 1855 1856 1857
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 判断的结果,如果是内置包含的Date对象类型为true,反之为false。 |

Z
zengyawen 已提交
1858
**示例:**
Z
zengyawen 已提交
1859
  ```
1860
  var that = new util.types();
Z
zengyawen 已提交
1861 1862 1863 1864 1865 1866
  var result = that.isDate(new Date());
  ```


### isExternal<sup>8+</sup>

X
xdmal 已提交
1867
isExternal(value: Object): boolean
Z
zengyawen 已提交
1868 1869 1870

检查输入的value是否是native External类型。

Z
zengyawen 已提交
1871 1872 1873
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
1874 1875 1876 1877
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | Object | 是 | 待检测对象。 |

Z
zengyawen 已提交
1878
**返回值:**
Z
zengyawen 已提交
1879 1880 1881 1882
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 判断的结果,如果是内置包含native&nbsp;External类型为true,反之为false。 |

Z
zengyawen 已提交
1883
**示例:**
Z
zengyawen 已提交
1884
  ```
1885
  var that = new util.types();
Z
zengyawen 已提交
1886 1887 1888 1889 1890 1891 1892
  const data = util.createExternalType();
  var result = that.isExternal(data);
  ```


### isFloat32Array<sup>8+</sup>

X
xdmal 已提交
1893
isFloat32Array(value: Object): boolean
Z
zengyawen 已提交
1894 1895 1896

检查输入的value是否是Float32Array数组类型。

Z
zengyawen 已提交
1897 1898 1899
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
1900 1901 1902 1903
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | Object | 是 | 待检测对象。 |

Z
zengyawen 已提交
1904
**返回值:**
Z
zengyawen 已提交
1905 1906 1907 1908
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 判断的结果,如果是内置包含的Float32Array数组类型为true,反之为false。 |

Z
zengyawen 已提交
1909
**示例:**
Z
zengyawen 已提交
1910
  ```
1911
  var that = new util.types();
Z
zengyawen 已提交
1912 1913 1914 1915 1916 1917
  var result = that.isFloat32Array(new Float32Array());
  ```


### isFloat64Array<sup>8+</sup>

X
xdmal 已提交
1918
isFloat64Array(value: Object): boolean
Z
zengyawen 已提交
1919 1920 1921

检查输入的value是否是Float64Array数组类型。

Z
zengyawen 已提交
1922 1923 1924
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
1925 1926 1927 1928
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | Object | 是 | 待检测对象。 |

Z
zengyawen 已提交
1929
**返回值:**
Z
zengyawen 已提交
1930 1931 1932 1933
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 判断的结果,如果是内置包含的Float64Array数组类型为true,反之为false。 |

Z
zengyawen 已提交
1934
**示例:**
Z
zengyawen 已提交
1935
  ```
1936
  var that = new util.types();
Z
zengyawen 已提交
1937 1938 1939 1940 1941 1942
  var result = that.isFloat64Array(new Float64Array());
  ```


### isGeneratorFunction<sup>8+</sup>

X
xdmal 已提交
1943
isGeneratorFunction(value: Object): boolean
Z
zengyawen 已提交
1944 1945 1946

检查输入的value是否是generator函数类型。

Z
zengyawen 已提交
1947 1948 1949
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
1950 1951 1952 1953
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | Object | 是 | 待检测对象。 |

Z
zengyawen 已提交
1954
**返回值:**
Z
zengyawen 已提交
1955 1956 1957 1958
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 判断的结果,如果是内置包含的generator函数类型为true,反之为false。 |

Z
zengyawen 已提交
1959
**示例:**
Z
zengyawen 已提交
1960
  ```
1961
  var that = new util.types();
Z
zengyawen 已提交
1962 1963 1964 1965 1966 1967
  var result = that.isGeneratorFunction(function* foo() {});
  ```


### isGeneratorObject<sup>8+</sup>

X
xdmal 已提交
1968
isGeneratorObject(value: Object): boolean
Z
zengyawen 已提交
1969 1970 1971

检查输入的value是否是generator对象类型。

Z
zengyawen 已提交
1972 1973 1974
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
1975 1976 1977 1978
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | Object | 是 | 待检测对象。 |

Z
zengyawen 已提交
1979
**返回值:**
Z
zengyawen 已提交
1980 1981 1982 1983
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 判断的结果,如果是内置包含的generator对象类型为true,反之为false。 |

Z
zengyawen 已提交
1984
**示例:**
Z
zengyawen 已提交
1985
  ```
1986
  var that = new util.types();
Z
zengyawen 已提交
1987 1988 1989 1990 1991 1992 1993 1994
  function* foo() {}
  const generator = foo();
  var result = that.isGeneratorObject(generator);
  ```


### isInt8Array<sup>8+</sup>

X
xdmal 已提交
1995
isInt8Array(value: Object): boolean
Z
zengyawen 已提交
1996 1997 1998

检查输入的value是否是Int8Array数组类型。

Z
zengyawen 已提交
1999 2000 2001
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
2002 2003 2004 2005
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | Object | 是 | 待检测对象。 |

Z
zengyawen 已提交
2006
**返回值:**
Z
zengyawen 已提交
2007 2008 2009 2010
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 判断的结果,如果是内置包含的Int8Array数组类型为true,反之为false。 |

Z
zengyawen 已提交
2011
**示例:**
Z
zengyawen 已提交
2012
  ```
2013
  var that = new util.types();
Z
zengyawen 已提交
2014 2015 2016 2017 2018 2019
  var result = that.isInt8Array(new Int8Array([]));
  ```


### isInt16Array<sup>8+</sup>

X
xdmal 已提交
2020
isInt16Array(value: Object): boolean
Z
zengyawen 已提交
2021 2022 2023

检查输入的value是否是Int16Array数组类型。

Z
zengyawen 已提交
2024 2025 2026
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
2027 2028 2029 2030
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | Object | 是 | 待检测对象。 |

Z
zengyawen 已提交
2031
**返回值:**
Z
zengyawen 已提交
2032 2033 2034 2035
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 判断的结果,如果是内置包含的Int16Array数组类型为true,反之为false。 |

Z
zengyawen 已提交
2036
**示例:**
Z
zengyawen 已提交
2037
  ```
2038
  var that = new util.types();
Z
zengyawen 已提交
2039 2040 2041 2042 2043 2044
  var result = that.isInt16Array(new Int16Array([]));
  ```


### isInt32Array<sup>8+</sup>

X
xdmal 已提交
2045
isInt32Array(value: Object): boolean
Z
zengyawen 已提交
2046 2047 2048

检查输入的value是否是Int32Array数组类型。

Z
zengyawen 已提交
2049 2050 2051
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
2052 2053 2054 2055
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | Object | 是 | 待检测对象。 |

Z
zengyawen 已提交
2056
**返回值:**
Z
zengyawen 已提交
2057 2058 2059 2060
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 判断的结果,如果是内置包含的Int32Array数组类型为true,反之为false。 |

Z
zengyawen 已提交
2061
**示例:**
Z
zengyawen 已提交
2062
  ```
2063
  var that = new util.types();
Z
zengyawen 已提交
2064 2065 2066 2067 2068 2069
  var result = that.isInt32Array(new Int32Array([]));
  ```


### isMap<sup>8+</sup>

X
xdmal 已提交
2070
isMap(value: Object): boolean
Z
zengyawen 已提交
2071 2072 2073

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

Z
zengyawen 已提交
2074 2075 2076
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
2077 2078 2079 2080
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | Object | 是 | 待检测对象。 |

Z
zengyawen 已提交
2081
**返回值:**
Z
zengyawen 已提交
2082 2083 2084 2085
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 判断的结果,如果是内置包含的Map类型为true,反之为false。 |

Z
zengyawen 已提交
2086
**示例:**
Z
zengyawen 已提交
2087
  ```
2088
  var that = new util.types();
Z
zengyawen 已提交
2089 2090 2091 2092 2093 2094
  var result = that.isMap(new Map());
  ```


### isMapIterator<sup>8+</sup>

X
xdmal 已提交
2095
isMapIterator(value: Object): boolean
Z
zengyawen 已提交
2096 2097 2098

检查输入的value是否是Map的Iterator类型。

Z
zengyawen 已提交
2099 2100 2101
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
2102 2103 2104 2105
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | Object | 是 | 待检测对象。 |

Z
zengyawen 已提交
2106
**返回值:**
Z
zengyawen 已提交
2107 2108 2109 2110
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 判断的结果,如果是内置包含的Map的Iterator类型为true,反之为false。 |

Z
zengyawen 已提交
2111
**示例:**
Z
zengyawen 已提交
2112
  ```
2113
  var that = new util.types();
Z
zengyawen 已提交
2114 2115 2116 2117 2118 2119 2120
  const map = new Map();
  var result = that.isMapIterator(map.keys());
  ```


### isNativeError<sup>8+</sup>

X
xdmal 已提交
2121
isNativeError(value: Object): boolean
Z
zengyawen 已提交
2122 2123 2124

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

Z
zengyawen 已提交
2125 2126 2127
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
2128 2129 2130 2131
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | Object | 是 | 待检测对象。 |

Z
zengyawen 已提交
2132
**返回值:**
Z
zengyawen 已提交
2133 2134 2135 2136
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 判断的结果,如果是内置包含的Error类型为true,反之为false。 |

Z
zengyawen 已提交
2137
**示例:**
Z
zengyawen 已提交
2138
  ```
2139
  var that = new util.types();
Z
zengyawen 已提交
2140 2141 2142 2143 2144 2145
  var result = that.isNativeError(new TypeError());
  ```


### isNumberObject<sup>8+</sup>

X
xdmal 已提交
2146
isNumberObject(value: Object): boolean
Z
zengyawen 已提交
2147 2148 2149

检查输入的value是否是Number对象类型。

Z
zengyawen 已提交
2150 2151 2152
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
2153 2154 2155 2156
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | Object | 是 | 待检测对象。 |

Z
zengyawen 已提交
2157
**返回值:**
Z
zengyawen 已提交
2158 2159 2160 2161
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 判断的结果,如果是内置包含的Number对象类型为true,反之为false。 |

Z
zengyawen 已提交
2162
**示例:**
Z
zengyawen 已提交
2163
  ```
2164
  var that = new util.types();
Z
zengyawen 已提交
2165 2166 2167 2168 2169 2170
  var result = that.isNumberObject(new Number(0));
  ```


### isPromise<sup>8+</sup>

X
xdmal 已提交
2171
isPromise(value: Object): boolean
Z
zengyawen 已提交
2172 2173 2174

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

Z
zengyawen 已提交
2175 2176 2177
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
2178 2179 2180 2181
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | Object | 是 | 待检测对象。 |

Z
zengyawen 已提交
2182
**返回值:**
Z
zengyawen 已提交
2183 2184 2185 2186
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 判断的结果,如果是内置包含的Promise类型为true,反之为false。 |

Z
zengyawen 已提交
2187
**示例:**
Z
zengyawen 已提交
2188
  ```
2189
  var that = new util.types();
Z
zengyawen 已提交
2190 2191 2192 2193 2194 2195
  var result = that.isPromise(Promise.resolve(1));
  ```


### isProxy<sup>8+</sup>

X
xdmal 已提交
2196
isProxy(value: Object): boolean
Z
zengyawen 已提交
2197 2198 2199

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

Z
zengyawen 已提交
2200 2201 2202
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
2203 2204 2205 2206
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | Object | 是 | 待检测对象。 |

Z
zengyawen 已提交
2207
**返回值:**
Z
zengyawen 已提交
2208 2209 2210 2211
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 判断的结果,如果是内置包含的Proxy类型为true,反之为false。 |

Z
zengyawen 已提交
2212
**示例:**
Z
zengyawen 已提交
2213
  ```
2214
  var that = new util.types();
Z
zengyawen 已提交
2215 2216 2217 2218 2219 2220 2221 2222
  const target = {};
  const proxy = new Proxy(target, {});
  var result = that.isProxy(proxy);
  ```


### isRegExp<sup>8+</sup>

X
xdmal 已提交
2223
isRegExp(value: Object): boolean
Z
zengyawen 已提交
2224 2225 2226

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

Z
zengyawen 已提交
2227 2228 2229
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
2230 2231 2232 2233
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | Object | 是 | 待检测对象。 |

Z
zengyawen 已提交
2234
**返回值:**
Z
zengyawen 已提交
2235 2236 2237 2238
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 判断的结果,如果是内置包含的RegExp类型为true,反之为false。 |

Z
zengyawen 已提交
2239
**示例:**
Z
zengyawen 已提交
2240
  ```
2241
  var that = new util.types();
Z
zengyawen 已提交
2242 2243 2244 2245 2246 2247
  var result = that.isRegExp(new RegExp('abc'));
  ```


### isSet<sup>8+</sup>

X
xdmal 已提交
2248
isSet(value: Object): boolean
Z
zengyawen 已提交
2249 2250 2251

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

Z
zengyawen 已提交
2252 2253 2254
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
2255 2256 2257 2258
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | Object | 是 | 待检测对象。 |

Z
zengyawen 已提交
2259
**返回值:**
Z
zengyawen 已提交
2260 2261 2262 2263
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 判断的结果,如果是内置包含的Set类型为true,反之为false。 |

Z
zengyawen 已提交
2264
**示例:**
Z
zengyawen 已提交
2265
  ```
2266
  var that = new util.types();
Z
zengyawen 已提交
2267 2268 2269 2270 2271 2272
  var result = that.isSet(new Set());
  ```


### isSetIterator<sup>8+</sup>

X
xdmal 已提交
2273
isSetIterator(value: Object): boolean
Z
zengyawen 已提交
2274 2275 2276

检查输入的value是否是Set的Iterator类型。

Z
zengyawen 已提交
2277 2278 2279
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
2280 2281 2282 2283
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | Object | 是 | 待检测对象。 |

Z
zengyawen 已提交
2284
**返回值:**
Z
zengyawen 已提交
2285 2286 2287 2288
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 判断的结果,如果是内置包含的Set的Iterator类型为true,反之为false。 |

Z
zengyawen 已提交
2289
**示例:**
Z
zengyawen 已提交
2290
  ```
2291
  var that = new util.types();
Z
zengyawen 已提交
2292 2293 2294 2295 2296 2297 2298
  const set = new Set();
  var result = that.isSetIterator(set.keys());
  ```


### isStringObject<sup>8+</sup>

X
xdmal 已提交
2299
isStringObject(value: Object): boolean
Z
zengyawen 已提交
2300 2301 2302

检查输入的value是否是String对象类型。

Z
zengyawen 已提交
2303 2304 2305
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
2306 2307 2308 2309
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | Object | 是 | 待检测对象。 |

Z
zengyawen 已提交
2310
**返回值:**
Z
zengyawen 已提交
2311 2312 2313 2314
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 判断的结果,如果是内置包含的String对象类型为true,反之为false。 |

Z
zengyawen 已提交
2315
**示例:**
Z
zengyawen 已提交
2316
  ```
2317
  var that = new util.types();
Z
zengyawen 已提交
2318 2319 2320 2321 2322 2323
  var result = that.isStringObject(new String('foo'));
  ```


### isSymbolObjec<sup>8+</sup>

X
xdmal 已提交
2324
isSymbolObject(value: Object): boolean
Z
zengyawen 已提交
2325 2326 2327

检查输入的value是否是Symbol对象类型。

Z
zengyawen 已提交
2328 2329 2330
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
2331 2332 2333 2334
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | Object | 是 | 待检测对象。 |

Z
zengyawen 已提交
2335
**返回值:**
Z
zengyawen 已提交
2336 2337 2338 2339
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 判断的结果,如果是内置包含的Symbol对象类型为true,反之为false。 |

Z
zengyawen 已提交
2340
**示例:**
Z
zengyawen 已提交
2341
  ```
2342
  var that = new util.types();
Z
zengyawen 已提交
2343 2344 2345 2346 2347 2348 2349
  const symbols = Symbol('foo');
  var result = that.isSymbolObject(Object(symbols));
  ```


### isTypedArray<sup>8+</sup>

X
xdmal 已提交
2350
isTypedArray(value: Object): boolean
Z
zengyawen 已提交
2351 2352 2353

检查输入的value是否是TypedArray类型的辅助类型。

Z
zengyawen 已提交
2354
TypedArray类型的辅助类型,包括Int8Array、Int16Array、Int32Array、Uint8Array、Uint8ClampedArray、Uint16Array、Uint32Array、Float32Array、Float64Array、DataView。
Z
zengyawen 已提交
2355

Z
zengyawen 已提交
2356 2357 2358
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
2359 2360 2361 2362
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | Object | 是 | 待检测对象。 |

Z
zengyawen 已提交
2363
**返回值:**
Z
zengyawen 已提交
2364 2365 2366 2367
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 判断的结果,如果是内置包含的TypedArray包含的类型为true,反之为false。 |

Z
zengyawen 已提交
2368
**示例:**
Z
zengyawen 已提交
2369
  ```
2370
  var that = new util.types();
Z
zengyawen 已提交
2371 2372 2373 2374 2375 2376
  var result = that.isTypedArray(new Float64Array([]));
  ```


### isUint8Array<sup>8+</sup>

X
xdmal 已提交
2377
isUint8Array(value: Object): boolean
Z
zengyawen 已提交
2378 2379 2380

检查输入的value是否是Uint8Array数组类型。

Z
zengyawen 已提交
2381 2382 2383
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
2384 2385 2386 2387
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | Object | 是 | 待检测对象。 |

Z
zengyawen 已提交
2388
**返回值:**
Z
zengyawen 已提交
2389 2390 2391 2392
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 判断的结果,如果是内置包含的Uint8Array数组类型为true,反之为false。 |

Z
zengyawen 已提交
2393
**示例:**
Z
zengyawen 已提交
2394
  ```
2395
  var that = new util.types();
Z
zengyawen 已提交
2396 2397 2398 2399 2400 2401
  var result = that.isUint8Array(new Uint8Array([]));
  ```


### isUint8ClampedArray<sup>8+</sup>

X
xdmal 已提交
2402
isUint8ClampedArray(value: Object): boolean
Z
zengyawen 已提交
2403 2404 2405

检查输入的value是否是Uint8ClampedArray数组类型。

Z
zengyawen 已提交
2406 2407 2408
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
2409 2410 2411 2412
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | Object | 是 | 待检测对象。 |

Z
zengyawen 已提交
2413
**返回值:**
Z
zengyawen 已提交
2414 2415 2416 2417
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 判断的结果,如果是内置包含的Uint8ClampedArray数组类型为true,反之为false。 |

Z
zengyawen 已提交
2418
**示例:**
Z
zengyawen 已提交
2419
  ```
2420
  var that = new util.types();
Z
zengyawen 已提交
2421 2422 2423 2424 2425 2426
  var result = that.isUint8ClampedArray(new Uint8ClampedArray([]));
  ```


### isUint16Array<sup>8+</sup>

X
xdmal 已提交
2427
isUint16Array(value: Object): boolean
Z
zengyawen 已提交
2428 2429 2430

检查输入的value是否是Uint16Array数组类型。

Z
zengyawen 已提交
2431 2432 2433
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
2434 2435 2436 2437
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | Object | 是 | 待检测对象。 |

Z
zengyawen 已提交
2438
**返回值:**
Z
zengyawen 已提交
2439 2440 2441 2442
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 判断的结果,如果是内置包含的Uint16Array数组类型为true,反之为false。 |

Z
zengyawen 已提交
2443
**示例:**
Z
zengyawen 已提交
2444
  ```
2445
  var that = new util.types();
Z
zengyawen 已提交
2446 2447 2448 2449 2450 2451
  var result = that.isUint16Array(new Uint16Array([]));
  ```


### isUint32Array<sup>8+</sup>

X
xdmal 已提交
2452
isUint32Array(value: Object): boolean
Z
zengyawen 已提交
2453 2454 2455

检查输入的value是否是Uint32Array数组类型。

Z
zengyawen 已提交
2456 2457 2458
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
2459 2460 2461 2462
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | Object | 是 | 待检测对象。 |

Z
zengyawen 已提交
2463
**返回值:**
Z
zengyawen 已提交
2464 2465 2466 2467
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 判断的结果,如果是内置包含的Uint32Array数组类型为true,反之为false。 |

Z
zengyawen 已提交
2468
**示例:**
Z
zengyawen 已提交
2469
  ```
2470
  var that = new util.types();
Z
zengyawen 已提交
2471 2472 2473 2474 2475 2476
  var result = that.isUint32Array(new Uint32Array([]));
  ```


### isWeakMap<sup>8+</sup>

X
xdmal 已提交
2477
isWeakMap(value: Object): boolean
Z
zengyawen 已提交
2478 2479 2480

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

Z
zengyawen 已提交
2481 2482 2483
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
2484 2485 2486 2487
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | Object | 是 | 待检测对象。 |

Z
zengyawen 已提交
2488
**返回值:**
Z
zengyawen 已提交
2489 2490 2491 2492
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 判断的结果,如果是内置包含的WeakMap类型为true,反之为false。 |

Z
zengyawen 已提交
2493
**示例:**
Z
zengyawen 已提交
2494
  ```
2495
  var that = new util.types();
Z
zengyawen 已提交
2496 2497 2498 2499 2500 2501
  var result = that.isWeakMap(new WeakMap());
  ```


### isWeakSet<sup>8+</sup>

X
xdmal 已提交
2502
isWeakSet(value: Object): boolean
Z
zengyawen 已提交
2503 2504 2505

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

Z
zengyawen 已提交
2506 2507 2508
**系统能力:** SystemCapability.Utils.Lang

**参数:**
Z
zengyawen 已提交
2509 2510 2511 2512
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | Object | 是 | 待检测对象。 |

Z
zengyawen 已提交
2513
**返回值:**
Z
zengyawen 已提交
2514 2515 2516 2517
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 判断的结果,如果是内置包含的WeakSet类型为true,反之为false。 |

Z
zengyawen 已提交
2518
**示例:**
Z
zengyawen 已提交
2519
  ```
2520
  var that = new util.types();
Z
zengyawen 已提交
2521 2522
  var result = that.isWeakSet(new WeakSet());
  ```