diff --git a/en/application-dev/reference/apis/js-apis-util.md b/en/application-dev/reference/apis/js-apis-util.md index ecc46e0c2d4b17d6d6a462c312a7860627b579a2..0ee9fb84705d1c23d9c453e75dd47689bc66d1d3 100755 --- a/en/application-dev/reference/apis/js-apis-util.md +++ b/en/application-dev/reference/apis/js-apis-util.md @@ -1,7 +1,7 @@ # util -> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE** +> **NOTE**
> The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version. @@ -23,15 +23,15 @@ Prints the input content in a formatted string. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| format | string | Yes| Format of the string to print.| -| ...args | Object[] | No| Data to format.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | format | string | Yes | Format of the string to print. | + | ...args | Object[] | No | Data to format. | **Return value** -| Type| Description| -| -------- | -------- | -| string | String in the specified format.| + | Type | Description | + | -------- | -------- | + | string | String in the specified format. | **Example** ```js @@ -49,14 +49,14 @@ Obtains detailed information about a system error code. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| errno | number | Yes| Error code generated.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | errno | number | Yes | Error code generated. | **Return value** -| Type| Description| -| -------- | -------- | -| string | Detailed information about the error code.| + | Type | Description | + | -------- | -------- | + | string | Detailed information about the error code. | **Example** ```js @@ -76,14 +76,14 @@ Calls back an asynchronous function. In the callback, the first parameter indica **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| original | Function | Yes| Asynchronous function.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | original | Function | Yes | Asynchronous function. | **Return value** -| Type| Description| -| -------- | -------- | -| Function | Callback, in which the first parameter indicates the cause of the rejection (the value is **null** if the promise has been resolved) and the second parameter indicates the resolved value.| + | Type | Description | + | -------- | -------- | + | Function | Callback, in which the first parameter indicates the cause of the rejection (the value is **null** if the promise has been resolved) and the second parameter indicates the resolved value. | **Example** ```js @@ -107,14 +107,14 @@ Processes an asynchronous function and returns a promise version. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| original | Function | Yes| Asynchronous function.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | original | Function | Yes | Asynchronous function. | **Return value** -| Type| Description| -| -------- | -------- | -| Function | Function in the error-first style (that is, **(err, value) =>...** is called as the last parameter) and the promise version.| + | Type | Description | + | -------- | -------- | + | Function | Function in the error-first style (that is, **(err, value) =>...** is called as the last parameter) and the promise version. | **Example** ```js @@ -138,11 +138,11 @@ Processes an asynchronous function and returns a promise version. **System capability**: SystemCapability.Utils.Lang -| Name| Type| Readable| Writable| Description| -| -------- | -------- | -------- | -------- | -------- | -| encoding | string | Yes| No| Encoding format.
- Supported formats: 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 | Yes| No| Whether to display fatal errors.| -| ignoreBOM | boolean | Yes| No| Whether to ignore the byte order marker (BOM). The default value is **false**, which indicates that the result contains the BOM.| + | Name | Type | Readable | Writable | Description | + | -------- | -------- | -------- | -------- | -------- | + | encoding | string | Yes | No | Encoding format.
- Supported formats: 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 | Yes | No | Whether to display fatal errors. | + | ignoreBOM | boolean | Yes | No | Whether to ignore the byte order marker (BOM). The default value is **false**, which indicates that the result contains the BOM. | ### constructor @@ -154,17 +154,17 @@ A constructor used to create a **TextDecoder** object. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| encoding | string | No| Encoding format.| -| options | Object | No| Encoding-related options, which include **fatal** and **ignoreBOM**.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | encoding | string | No | Encoding format. | + | options | Object | No | Encoding-related options, which include **fatal** and **ignoreBOM**. | **Table 1** options -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| fatal | boolean | No| Whether to display fatal errors.| -| ignoreBOM | boolean | No| Whether to ignore the BOM.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | fatal | boolean | No | Whether to display fatal errors. | + | ignoreBOM | boolean | No | Whether to ignore the BOM. | **Example** ```js @@ -181,21 +181,21 @@ Decodes the input content. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| input | Unit8Array | Yes| Uint8Array to decode.| -| options | Object | No| Options related to decoding.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | input | Unit8Array | Yes | Uint8Array to decode. | + | options | Object | No | Options related to decoding. | **Table 2** options -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| stream | boolean | No| Whether to allow data blocks in subsequent **decode()**. If data is processed in blocks, set this parameter to **true**. If this is the last data block to process or data is not divided into blocks, set this parameter to **false**. The default value is **false**.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | stream | boolean | No | Whether to allow data blocks in subsequent **decode()**. If data is processed in blocks, set this parameter to **true**. If this is the last data block to process or data is not divided into blocks, set this parameter to **false**. The default value is **false**. | **Return value** -| Type| Description| -| -------- | -------- | -| string | Data decoded.| + | Type | Description | + | -------- | -------- | + | string | Data decoded. | **Example** ```js @@ -222,9 +222,9 @@ Decodes the input content. **System capability**: SystemCapability.Utils.Lang -| Name| Type| Readable| Writable| Description| -| -------- | -------- | -------- | -------- | -------- | -| encoding | string | Yes| No| Encoding format. The default format is **utf-8**.| + | Name | Type | Readable | Writable | Description | + | -------- | -------- | -------- | -------- | -------- | + | encoding | string | Yes | No | Encoding format. The default format is **utf-8**. | ### constructor @@ -250,14 +250,14 @@ Encodes the input content. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| input | string | Yes| String to encode.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | input | string | Yes | String to encode. | **Return value** -| Type| Description| -| -------- | -------- | -| Uint8Array | Encoded text.| + | Type | Description | + | -------- | -------- | + | Uint8Array | Encoded text. | **Example** ```js @@ -276,15 +276,15 @@ Stores the UTF-8 encoded text. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| input | string | Yes| String to encode.| -| dest | Uint8Array | Yes| **Uint8Array** instance used to store the UTF-8 encoded text.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | input | string | Yes | String to encode. | + | dest | Uint8Array | Yes | **Uint8Array** instance used to store the UTF-8 encoded text. | **Return value** -| Type| Description| -| -------- | -------- | -| Uint8Array | Encoded text.| + | Type | Description | + | -------- | -------- | + | Uint8Array | Encoded text. | **Example** ```js @@ -306,10 +306,10 @@ A constructor used to create a **RationalNumber** object. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| numerator | number | Yes| Numerator, which is an integer.| -| denominator | number | Yes| Denominator, which is an integer.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | numerator | number | Yes | Numerator, which is an integer. | + | denominator | number | Yes | Denominator, which is an integer. | **Example** ```js @@ -326,14 +326,14 @@ Creates a **RationalNumber** object based on the given string. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| rationalString | string | Yes| String used to create the **RationalNumber** object.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | rationalString | string | Yes | String used to create the **RationalNumber** object. | **Return value** -| Type| Description| -| -------- | -------- | -| object | **RationalNumber** object created.| + | Type | Description | + | -------- | -------- | + | object | **RationalNumber** object created. | **Example** ```js @@ -351,14 +351,14 @@ Compares this **RationalNumber** object with a given object. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| another | RationalNumber | Yes| Object used to compare with this **RationalNumber** object.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | another | RationalNumber | Yes | Object used to compare with this **RationalNumber** object. | **Return value** -| Type| Description| -| -------- | -------- | -| number | Returns **0** if the two objects are equal; returns **1** if the given object is less than this object; return **-1** if the given object is greater than this object.| + | Type | Description | + | -------- | -------- | + | number | Returns **0** if the two objects are equal; returns **1** if the given object is less than this object; return **-1** if the given object is greater than this object. | **Example** @@ -378,9 +378,9 @@ Obtains the value of this **RationalNumber** object as an integer or a floating- **System capability**: SystemCapability.Utils.Lang **Return value** -| Type| Description| -| -------- | -------- | -| number | An integer or a floating-point number.| + | Type | Description | + | -------- | -------- | + | number | An integer or a floating-point number. | **Example** ```js @@ -398,14 +398,14 @@ Checks whether this **RationalNumber** object equals the given object. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| object | Object | Yes| Object used to compare with this **RationalNumber** object.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | object | Object | Yes | Object used to compare with this **RationalNumber** object. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the two objects are equal; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the two objects are equal; returns **false** otherwise. | **Example** ```js @@ -424,15 +424,15 @@ Obtains the greatest common divisor of two specified integers. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| number1 | number | Yes| The first integer used to get the greatest common divisor.| -| number2 | number | Yes| The second integer used to get the greatest common divisor.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | number1 | number | Yes | The first integer used to get the greatest common divisor. | + | number2 | number | Yes | The second integer used to get the greatest common divisor. | **Return value** -| Type| Description| -| -------- | -------- | -| number | Greatest common divisor obtained.| + | Type | Description | + | -------- | -------- | + | number | Greatest common divisor obtained. | **Example** ```js @@ -451,9 +451,9 @@ Obtains the numerator of this **RationalNumber** object. **Return value** -| Type| Description| -| -------- | -------- | -| number | Numerator of this **RationalNumber** object.| + | Type | Description | + | -------- | -------- | + | number | Numerator of this **RationalNumber** object. | **Example** ```js @@ -471,9 +471,9 @@ Obtains the denominator of this **RationalNumber** object. **System capability**: SystemCapability.Utils.Lang **Return value** -| Type| Description| -| -------- | -------- | -| number | Denominator of this **RationalNumber** object.| + | Type | Description | + | -------- | -------- | + | number | Denominator of this **RationalNumber** object. | **Example** ```js @@ -491,9 +491,9 @@ Checks whether this **RationalNumber** object is **0**. **System capability**: SystemCapability.Utils.Lang **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the value of this **RationalNumber** object is **0**; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the value of this **RationalNumber** object is **0**; returns **false** otherwise. | **Example** ```js @@ -511,9 +511,9 @@ Checks whether this **RationalNumber** object is a Not a Number (NaN). **System capability**: SystemCapability.Utils.Lang **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if this **RationalNumber** object is a NaN (the denominator and numerator are both **0**); returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if this **RationalNumber** object is a NaN (the denominator and numerator are both **0**); returns **false** otherwise. | **Example** ```js @@ -531,9 +531,9 @@ Checks whether this **RationalNumber** object represents a finite value. **System capability**: SystemCapability.Utils.Lang **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if this **RationalNumber** object represents a finite value (the denominator is not **0**); returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if this **RationalNumber** object represents a finite value (the denominator is not **0**); returns **false** otherwise. | **Example** ```js @@ -551,9 +551,9 @@ Obtains the string representation of this **RationalNumber** object. **System capability**: SystemCapability.Utils.Lang **Return value** -| Type| Description| -| -------- | -------- | -| string | Returns **NaN** if the numerator and denominator of this object are both **0**; returns a string in Numerator/Denominator format otherwise, for example, **3/5**.| + | Type | Description | + | -------- | -------- | + | string | Returns **NaN** if the numerator and denominator of this object are both **0**; returns a string in Numerator/Denominator format otherwise, for example, **3/5**. | **Example** ```js @@ -567,9 +567,9 @@ Obtains the string representation of this **RationalNumber** object. **System capability**: SystemCapability.Utils.Lang -| Name| Type| Readable| Writable| Description| -| -------- | -------- | -------- | -------- | -------- | -| length | number | Yes| No| Total number of values in this buffer.| + | Name | Type | Readable | Writable | Description | + | -------- | -------- | -------- | -------- | -------- | + | length | number | Yes | No | Total number of values in this buffer. | **Example** ```js @@ -589,9 +589,9 @@ A constructor used to create an **LruBuffer** instance. The default capacity of **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| capacity | number | No| Capacity of the **LruBuffer** to create.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | capacity | number | No | Capacity of the **LruBuffer** to create. | **Example** ```js @@ -608,9 +608,9 @@ Changes the **LruBuffer** capacity. If the new capacity is less than or equal to **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| newCapacity | number | Yes| New capacity of the **LruBuffer**.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | newCapacity | number | Yes | New capacity of the **LruBuffer**. | **Example** ```js @@ -628,9 +628,9 @@ Obtains the string representation of this **LruBuffer** object. **System capability**: SystemCapability.Utils.Lang **Return value** -| Type| Description| -| -------- | -------- | -| string | String representation of this **LruBuffer** object.| + | Type | Description | + | -------- | -------- | + | string | String representation of this **LruBuffer** object. | **Example** ```js @@ -651,9 +651,9 @@ Obtains the capacity of this buffer. **System capability**: SystemCapability.Utils.Lang **Return value** -| Type| Description| -| -------- | -------- | -| number | Capacity of this buffer.| + | Type | Description | + | -------- | -------- | + | number | Capacity of this buffer. | **Example** ```js @@ -688,9 +688,9 @@ Obtains the number of return values for **createDefault()**. **System capability**: SystemCapability.Utils.Lang **Return value** -| Type| Description| -| -------- | -------- | -| number | Number of return values for **createDefault()**.| + | Type | Description | + | -------- | -------- | + | number | Number of return values for **createDefault()**. | **Example** ```js @@ -709,9 +709,9 @@ Obtains the number of times that the queried values are mismatched. **System capability**: SystemCapability.Utils.Lang **Return value** -| Type| Description| -| -------- | -------- | -| number | Number of times that the queried values are mismatched.| + | Type | Description | + | -------- | -------- | + | number | Number of times that the queried values are mismatched. | **Example** ```js @@ -731,9 +731,9 @@ Obtains the number of removals from this buffer. **System capability**: SystemCapability.Utils.Lang **Return value** -| Type| Description| -| -------- | -------- | -| number | Number of removals from the buffer.| + | Type | Description | + | -------- | -------- | + | number | Number of removals from the buffer. | **Example** ```js @@ -754,9 +754,9 @@ Obtains the number of times that the queried values are matched. **System capability**: SystemCapability.Utils.Lang **Return value** -| Type| Description| -| -------- | -------- | -| number | Number of times that the queried values are matched.| + | Type | Description | + | -------- | -------- | + | number | Number of times that the queried values are matched. | **Example** ```js @@ -776,9 +776,9 @@ Obtains the number of additions to this buffer. **System capability**: SystemCapability.Utils.Lang **Return value** -| Type| Description| -| -------- | -------- | -| number | Number of additions to the buffer.| + | Type | Description | + | -------- | -------- | + | number | Number of additions to the buffer. | **Example** ```js @@ -797,9 +797,9 @@ Checks whether this buffer is empty. **System capability**: SystemCapability.Utils.Lang **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the buffer does not contain any value.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the buffer does not contain any value. | **Example** ```js @@ -811,21 +811,21 @@ Checks whether this buffer is empty. ### get8+ -get(key: K): V | undefined +get(key: K): V | undefined Obtains the value of the specified key. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| key | K | Yes| Key based on which the value is queried.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | key | K | Yes | Key based on which the value is queried. | **Return value** -| Type| Description| -| -------- | -------- | -| V \| undefind | Returns the value of the key if a match is found in the buffer; returns **undefined** otherwise.| + | Type | Description | + | -------- | -------- | + | V \ | undefind | Returns the value of the key if a match is found in the buffer; returns **undefined** otherwise. | **Example** ```js @@ -844,15 +844,15 @@ Adds a key-value pair to this buffer. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| key | K | Yes| Key of the key-value pair to add.| -| value | V | Yes| Value of the key-value pair to add.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | key | K | Yes | Key of the key-value pair to add. | + | value | V | Yes | Value of the key-value pair to add. | **Return value** -| Type| Description| -| -------- | -------- | -| V | Returns the existing value if the key already exists; returns the value added otherwise. If the key or value is null, an exception will be thrown. | + | Type | Description | + | -------- | -------- | + | V | Returns the existing value if the key already exists; returns the value added otherwise. If the key or value is null, an exception will be thrown. | **Example** ```js @@ -870,9 +870,9 @@ Obtains all values in this buffer, listed from the most to the least recently ac **System capability**: SystemCapability.Utils.Lang **Return value** -| Type| Description| -| -------- | -------- | -| V [] | All values in the buffer, listed from the most to the least recently accessed.| + | Type | Description | + | -------- | -------- | + | V [] | All values in the buffer, listed from the most to the least recently accessed. | **Example** ```js @@ -893,9 +893,9 @@ Obtains all keys in this buffer, listed from the most to the least recently acce **System capability**: SystemCapability.Utils.Lang **Return value** -| Type| Description| -| -------- | -------- | -| K [] | All keys in the buffer, listed from the most to the least recently accessed.| + | Type | Description | + | -------- | -------- | + | K [] | All keys in the buffer, listed from the most to the least recently accessed. | **Example** ```js @@ -907,21 +907,21 @@ Obtains all keys in this buffer, listed from the most to the least recently acce ### remove8+ -remove(key: K): V | undefined +remove(key: K): V | undefined Removes the specified key and its value from this buffer. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| key | K | Yes| Key to remove.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | key | K | Yes | Key to remove. | **Return value** -| Type| Description| -| -------- | -------- | -| V \| undefind | Returns an **Optional** object containing the removed key-value pair if the key exists in the buffer; returns an empty **Optional** object otherwise. If the key is null, an exception will be thrown.| + | Type | Description | + | -------- | -------- | + | V \ | undefind | Returns an **Optional** object containing the removed key-value pair if the key exists in the buffer; returns an empty **Optional** object otherwise. If the key is null, an exception will be thrown. | **Example** ```js @@ -940,12 +940,12 @@ Performs subsequent operations after a value is removed. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| isEvict | boolean | No| Whether the buffer capacity is insufficient. If the value is **true**, this method is called due to insufficient capacity.| -| key | K | Yes| Key removed.| -| value | V | Yes| Value removed.| -| newValue | V | No| New value for the key if the **put()** method is called and the key to be added already exists. In other cases, this parameter is left blank.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | isEvict | boolean | No | Whether the buffer capacity is insufficient. If the value is **true**, this method is called due to insufficient capacity. | + | key | K | Yes | Key removed. | + | value | V | Yes | Value removed. | + | newValue | V | No | New value for the key if the **put()** method is called and the key to be added already exists. In other cases, this parameter is left blank. | **Example** ```js @@ -985,14 +985,14 @@ Checks whether this buffer contains the specified key. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| key | K | Yes| Key to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | key | K | Yes | Key to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the buffer contains the specified key; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the buffer contains the specified key; returns **false** otherwise. | **Example** ```js @@ -1011,14 +1011,14 @@ Creates a value if the value of the specified key is not available. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| key | K | Yes| Key of which the value is missing.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | key | K | Yes | Key of which the value is missing. | **Return value** -| Type| Description| -| -------- | -------- | -| V | Value of the key.| + | Type | Description | + | -------- | -------- | + | V | Value of the key. | **Example** ```js @@ -1036,9 +1036,9 @@ Obtains a new iterator object that contains all key-value pairs in this object. **System capability**: SystemCapability.Utils.Lang **Return value** -| Type| Description| -| -------- | -------- | -| [K, V] | Iterable array.| + | Type | Description | + | -------- | -------- | + | [K, V] | Iterable array. | **Example** ```js @@ -1057,9 +1057,9 @@ Obtains a two-dimensional array in key-value pairs. **System capability**: SystemCapability.Utils.Lang **Return value** -| Type| Description| -| -------- | -------- | -| [K, V] | Two-dimensional array in key-value pairs.| + | Type | Description | + | -------- | -------- | + | [K, V] | Two-dimensional array in key-value pairs. | **Example** ```js @@ -1081,7 +1081,7 @@ The values of the **ScopeComparable** type are used to implement the **compareTo interface ScopeComparable{ compareTo(other: ScopeComparable): boolean; } -type ScopeType = ScopeComparable | number; +type ScopeType = ScopeComparable | number; ``` @@ -1116,10 +1116,10 @@ A constructor used to create a **Scope** object with the specified upper and low **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| lowerObj | [ScopeType](#scopetype8) | Yes| Lower limit of the **Scope** object.| -| upperObj | [ScopeType](#scopetype8) | Yes| Upper limit of the **Scope** object.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | lowerObj | [ScopeType](#scopetype8) | Yes | Lower limit of the **Scope** object. | + | upperObj | [ScopeType](#scopetype8) | Yes | Upper limit of the **Scope** object. | **Example** ```js @@ -1138,9 +1138,9 @@ Obtains a string representation that contains this **Scope**. **System capability**: SystemCapability.Utils.Lang **Return value** -| Type| Description| -| -------- | -------- | -| string | String representation containing the **Scope**.| + | Type | Description | + | -------- | -------- | + | string | String representation containing the **Scope**. | **Example** ```js @@ -1160,14 +1160,14 @@ Obtains the intersection of this **Scope** and the given **Scope**. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| range | [Scope](#scope8) | Yes| **Scope** specified.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | range | [Scope](#scope8) | Yes | **Scope** specified. | **Return value** -| Type| Description| -| -------- | -------- | -| [Scope](#scope8) | Intersection of this **Scope** and the given **Scope**.| + | Type | Description | + | -------- | -------- | + | [Scope](#scope8) | Intersection of this **Scope** and the given **Scope**. | **Example** ```js @@ -1190,15 +1190,15 @@ Obtains the intersection of this **Scope** and the given lower and upper limits. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| lowerObj | [ScopeType](#scopetype8) | Yes| Lower limit.| -| upperObj | [ScopeType](#scopetype8) | Yes| Upper limit.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | lowerObj | [ScopeType](#scopetype8) | Yes | Lower limit. | + | upperObj | [ScopeType](#scopetype8) | Yes | Upper limit. | **Return value** -| Type| Description| -| -------- | -------- | -| [Scope](#scope8) | Intersection of this **Scope** and the given lower and upper limits.| + | Type | Description | + | -------- | -------- | + | [Scope](#scope8) | Intersection of this **Scope** and the given lower and upper limits. | **Example** ```js @@ -1221,9 +1221,9 @@ Obtains the upper limit of this **Scope**. **Return value** -| Type| Description| -| -------- | -------- | -| [ScopeType](#scopetype8) | Upper limit of this **Scope**.| + | Type | Description | + | -------- | -------- | + | [ScopeType](#scopetype8) | Upper limit of this **Scope**. | **Example** ```js @@ -1243,9 +1243,9 @@ Obtains the lower limit of this **Scope**. **System capability**: SystemCapability.Utils.Lang **Return value** -| Type| Description| -| -------- | -------- | -| [ScopeType](#scopetype8) | Lower limit of this **Scope**.| + | Type | Description | + | -------- | -------- | + | [ScopeType](#scopetype8) | Lower limit of this **Scope**. | **Example** ```js @@ -1265,15 +1265,15 @@ Obtains the union set of this **Scope** and the given lower and upper limits. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| lowerObj | [ScopeType](#scopetype8) | Yes| Lower limit.| -| upperObj | [ScopeType](#scopetype8) | Yes| Upper limit.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | lowerObj | [ScopeType](#scopetype8) | Yes | Lower limit. | + | upperObj | [ScopeType](#scopetype8) | Yes | Upper limit. | **Return value** -| Type| Description| -| -------- | -------- | -| [Scope](#scope8) | Union set of this **Scope** and the given lower and upper limits.| + | Type | Description | + | -------- | -------- | + | [Scope](#scope8) | Union set of this **Scope** and the given lower and upper limits. | **Example** ```js @@ -1295,14 +1295,14 @@ Obtains the union set of this **Scope** and the given **Scope**. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| range | [Scope](#scope8) | Yes| **Scope** specified.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | range | [Scope](#scope8) | Yes | **Scope** specified. | **Return value** -| Type| Description| -| -------- | -------- | -| [Scope](#scope8) | Union set of this **Scope** and the given **Scope**.| + | Type | Description | + | -------- | -------- | + | [Scope](#scope8) | Union set of this **Scope** and the given **Scope**. | **Example** ```js @@ -1325,14 +1325,14 @@ Obtains the union set of this **Scope** and the given value. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | [ScopeType](#scopetype8) | Yes| Value specified.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | [ScopeType](#scopetype8) | Yes | Value specified. | **Return value** -| Type| Description| -| -------- | -------- | -| [Scope](#scope8) | Union set of this **Scope** and the given value.| + | Type | Description | + | -------- | -------- | + | [Scope](#scope8) | Union set of this **Scope** and the given value. | **Example** ```js @@ -1353,14 +1353,14 @@ Checks whether a value is within this **Scope**. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | [ScopeType](#scopetype8) | Yes| Value specified.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | [ScopeType](#scopetype8) | Yes | Value specified. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the value is within this **Scope**; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the value is within this **Scope**; returns **false** otherwise. | **Example** ```js @@ -1381,14 +1381,14 @@ Checks whether a range is within this **Scope**. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| range | [Scope](#scope8) | Yes| **Scope** specified.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | range | [Scope](#scope8) | Yes | **Scope** specified. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the range is within this **Scope**; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the range is within this **Scope**; returns **false** otherwise. | **Example** ```js @@ -1411,14 +1411,14 @@ Limits a value to this **Scope**. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | [ScopeType](#scopetype8) | Yes| Value specified.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | [ScopeType](#scopetype8) | Yes | Value specified. | **Return value** -| Type| Description| -| -------- | -------- | -| [ScopeType](#scopetype8) | Returns **lowerObj** if the specified value is less than the lower limit; returns **upperObj** if the specified value is greater than the upper limit; returns the specified value if it is within this **Scope**.| + | Type | Description | + | -------- | -------- | + | [ScopeType](#scopetype8) | Returns **lowerObj** if the specified value is less than the lower limit; returns **upperObj** if the specified value is greater than the upper limit; returns the specified value if it is within this **Scope**. | **Example** ```js @@ -1456,14 +1456,14 @@ Encodes the input content. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| src | Uint8Array | Yes| Uint8Array to encode.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | src | Uint8Array | Yes | Uint8Array to encode. | **Return value** -| Type| Description| -| -------- | -------- | -| Uint8Array | Uint8Array encoded.| + | Type | Description | + | -------- | -------- | + | Uint8Array | Uint8Array encoded. | **Example** ```js @@ -1482,14 +1482,14 @@ Encodes the input content. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| src | Uint8Array | Yes| Uint8Array to encode.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | src | Uint8Array | Yes | Uint8Array to encode. | **Return value** -| Type| Description| -| -------- | -------- | -| string | String encoded from the Uint8Array.| + | Type | Description | + | -------- | -------- | + | string | String encoded from the Uint8Array. | **Example** ```js @@ -1501,21 +1501,21 @@ Encodes the input content. ### decodeSync8+ -decodeSync(src: Uint8Array | string): Uint8Array +decodeSync(src: Uint8Array | string): Uint8Array Decodes the input content. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| src | Uint8Array \| string | Yes| Uint8Array or string to decode.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | src | Uint8Array \ | string | Yes | Uint8Array or string to decode. | **Return value** -| Type| Description| -| -------- | -------- | -| Uint8Array | Uint8Array decoded.| + | Type | Description | + | -------- | -------- | + | Uint8Array | Uint8Array decoded. | **Example** ```js @@ -1534,14 +1534,14 @@ Encodes the input content asynchronously. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| src | Uint8Array | Yes| Uint8Array to encode asynchronously.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | src | Uint8Array | Yes | Uint8Array to encode asynchronously. | **Return value** -| Type| Description| -| -------- | -------- | -| Promise<Uint8Array> | Uint8Array obtained after asynchronous encoding.| + | Type | Description | + | -------- | -------- | + | Promise<Uint8Array> | Uint8Array obtained after asynchronous encoding. | **Example** ```js @@ -1565,14 +1565,14 @@ Encodes the input content asynchronously. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| src | Uint8Array | Yes| Uint8Array to encode asynchronously.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | src | Uint8Array | Yes | Uint8Array to encode asynchronously. | **Return value** -| Type| Description| -| -------- | -------- | -| Promise<string> | String obtained after asynchronous encoding.| + | Type | Description | + | -------- | -------- | + | Promise<string> | String obtained after asynchronous encoding. | **Example** ```js @@ -1586,21 +1586,21 @@ Encodes the input content asynchronously. ### decode8+ -decode(src: Uint8Array | string): Promise<Uint8Array> +decode(src: Uint8Array | string): Promise<Uint8Array> Decodes the input content asynchronously. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| src | Uint8Array \| string | Yes| Uint8Array or string to decode asynchronously.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | src | Uint8Array \ | string | Yes | Uint8Array or string to decode asynchronously. | **Return value** -| Type| Description| -| -------- | -------- | -| Promise<Uint8Array> | Uint8Array obtained after asynchronous decoding.| + | Type | Description | + | -------- | -------- | + | Promise<Uint8Array> | Uint8Array obtained after asynchronous decoding. | **Example** ```js @@ -1641,14 +1641,14 @@ Checks whether the input value is of the **ArrayBuffer** type. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | Object | Yes| Object to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | Object | Yes | Object to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the input value is of the **ArrayBuffer** type; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the input value is of the **ArrayBuffer** type; returns **false** otherwise. | **Example** ```js @@ -1668,14 +1668,14 @@ Checks whether the input value is of the **ArrayBufferView** type. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | Object | Yes| Object to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | Object | Yes | Object to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the input value is of the **ArrayBufferView** type; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the input value is of the **ArrayBufferView** type; returns **false** otherwise. | **Example** ```js @@ -1693,14 +1693,14 @@ Checks whether the input value is of the **arguments** type. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | Object | Yes| Object to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | Object | Yes | Object to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the input value is of the **arguments** type; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the input value is of the **arguments** type; returns **false** otherwise. | **Example** ```js @@ -1721,14 +1721,14 @@ Checks whether the input value is of the **ArrayBuffer** type. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | Object | Yes| Object to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | Object | Yes | Object to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the input value is of the **ArrayBuffer** type; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the input value is of the **ArrayBuffer** type; returns **false** otherwise. | **Example** ```js @@ -1746,14 +1746,14 @@ Checks whether the input value is an asynchronous function. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | Object | Yes| Object to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | Object | Yes | Object to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the input value is an asynchronous function; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the input value is an asynchronous function; returns **false** otherwise. | **Example** ```js @@ -1771,14 +1771,14 @@ Checks whether the input value is of the **Boolean** type. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | Object | Yes| Object to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | Object | Yes | Object to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the input value is of the **Boolean** type; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the input value is of the **Boolean** type; returns **false** otherwise. | **Example** ```js @@ -1796,14 +1796,14 @@ Checks whether the input value is of the **Boolean**, **Number**, **String**, or **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | Object | Yes| Object to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | Object | Yes | Object to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the input value is of the **Boolean**, **Number**, **String**, or **Symbol** type; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the input value is of the **Boolean**, **Number**, **String**, or **Symbol** type; returns **false** otherwise. | **Example** ```js @@ -1821,14 +1821,14 @@ Checks whether the input value is of the **DataView** type. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | Object | Yes| Object to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | Object | Yes | Object to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the input value is of the **DataView** type; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the input value is of the **DataView** type; returns **false** otherwise. | **Example** ```js @@ -1847,14 +1847,14 @@ Checks whether the input value is of the **Date** type. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | Object | Yes| Object to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | Object | Yes | Object to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the input value is of the **Date** type; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the input value is of the **Date** type; returns **false** otherwise. | **Example** ```js @@ -1872,14 +1872,14 @@ Checks whether the input value is of the **native external** type. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | Object | Yes| Object to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | Object | Yes | Object to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the input value is of the **native external** type; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the input value is of the **native external** type; returns **false** otherwise. | **Example** ```js @@ -1898,14 +1898,14 @@ Checks whether the input value is of the **Float32Array** type. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | Object | Yes| Object to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | Object | Yes | Object to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the input value is of the **Float32Array** type; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the input value is of the **Float32Array** type; returns **false** otherwise. | **Example** ```js @@ -1923,14 +1923,14 @@ Checks whether the input value is of the **Float64Array** type. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | Object | Yes| Object to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | Object | Yes | Object to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the input value is of the **Float64Array** type; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the input value is of the **Float64Array** type; returns **false** otherwise. | **Example** ```js @@ -1948,14 +1948,14 @@ Checks whether the input value is a generator function. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | Object | Yes| Object to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | Object | Yes | Object to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the input value is a generator function; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the input value is a generator function; returns **false** otherwise. | **Example** ```js @@ -1973,14 +1973,14 @@ Checks whether the input value is a generator object. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | Object | Yes| Object to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | Object | Yes | Object to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the input value is a generator object; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the input value is a generator object; returns **false** otherwise. | **Example** ```js @@ -2000,14 +2000,14 @@ Checks whether the input value is of the **Int8Array** type. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | Object | Yes| Object to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | Object | Yes | Object to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the input value is of the **Int8Array** type; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the input value is of the **Int8Array** type; returns **false** otherwise. | **Example** ```js @@ -2025,14 +2025,14 @@ Checks whether the input value is of the **Int16Array** type. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | Object | Yes| Object to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | Object | Yes | Object to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the input value is of the **Int16Array** type; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the input value is of the **Int16Array** type; returns **false** otherwise. | **Example** ```js @@ -2050,14 +2050,14 @@ Checks whether the input value is of the **Int32Array** type. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | Object | Yes| Object to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | Object | Yes | Object to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the input value is of the **Int32Array** type; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the input value is of the **Int32Array** type; returns **false** otherwise. | **Example** ```js @@ -2075,14 +2075,14 @@ Checks whether the input value is of the **Map** type. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | Object | Yes| Object to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | Object | Yes | Object to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the input value is of the **Map** type; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the input value is of the **Map** type; returns **false** otherwise. | **Example** ```js @@ -2100,14 +2100,14 @@ Checks whether the input value is of the **MapIterator** type. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | Object | Yes| Object to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | Object | Yes | Object to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the input value is of the **MapIterator** type; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the input value is of the **MapIterator** type; returns **false** otherwise. | **Example** ```js @@ -2126,14 +2126,14 @@ Checks whether the input value is of the **Error** type. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | Object | Yes| Object to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | Object | Yes | Object to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the input value is of the **Error** type; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the input value is of the **Error** type; returns **false** otherwise. | **Example** ```js @@ -2151,14 +2151,14 @@ Checks whether the input value is a number object. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | Object | Yes| Object to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | Object | Yes | Object to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the input value is a number object; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the input value is a number object; returns **false** otherwise. | **Example** ```js @@ -2176,14 +2176,14 @@ Checks whether the input value is a promise. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | Object | Yes| Object to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | Object | Yes | Object to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the input value is a promise; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the input value is a promise; returns **false** otherwise. | **Example** ```js @@ -2201,14 +2201,14 @@ Checks whether the input value is a proxy. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | Object | Yes| Object to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | Object | Yes | Object to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the input value is a proxy; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the input value is a proxy; returns **false** otherwise. | **Example** ```js @@ -2228,14 +2228,14 @@ Checks whether the input value is of the **RegExp** type. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | Object | Yes| Object to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | Object | Yes | Object to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the input value is of the **RegExp** type; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the input value is of the **RegExp** type; returns **false** otherwise. | **Example** ```js @@ -2253,14 +2253,14 @@ Checks whether the input value is of the **Set** type. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | Object | Yes| Object to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | Object | Yes | Object to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the input value is of the **Set** type; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the input value is of the **Set** type; returns **false** otherwise. | **Example** ```js @@ -2278,14 +2278,14 @@ Checks whether the input value is of the **SetIterator** type. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | Object | Yes| Object to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | Object | Yes | Object to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the input value is of the **SetIterator** type; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the input value is of the **SetIterator** type; returns **false** otherwise. | **Example** ```js @@ -2304,14 +2304,14 @@ Checks whether the input value is a string object. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | Object | Yes| Object to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | Object | Yes | Object to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the input value is a string object; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the input value is a string object; returns **false** otherwise. | **Example** ```js @@ -2329,14 +2329,14 @@ Checks whether the input value is a symbol object. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | Object | Yes| Object to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | Object | Yes | Object to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the input value is a symbol object; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the input value is a symbol object; returns **false** otherwise. | **Example** ```js @@ -2357,14 +2357,14 @@ Checks whether the input value is of the **TypedArray** type. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | Object | Yes| Object to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | Object | Yes | Object to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the input value is of the **TypedArray** type; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the input value is of the **TypedArray** type; returns **false** otherwise. | **Example** ```js @@ -2382,14 +2382,14 @@ Checks whether the input value is of the **Uint8Array** type. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | Object | Yes| Object to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | Object | Yes | Object to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the input value is of the **Uint8Array** type; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the input value is of the **Uint8Array** type; returns **false** otherwise. | **Example** ```js @@ -2407,14 +2407,14 @@ Checks whether the input value is of the **Uint8ClampedArray** type. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | Object | Yes| Object to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | Object | Yes | Object to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the input value is of the **Uint8ClampedArray** type; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the input value is of the **Uint8ClampedArray** type; returns **false** otherwise. | **Example** ```js @@ -2432,14 +2432,14 @@ Checks whether the input value is of the **Uint16Array** type. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | Object | Yes| Object to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | Object | Yes | Object to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the input value is of the **Uint16Array** type; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the input value is of the **Uint16Array** type; returns **false** otherwise. | **Example** ```js @@ -2457,14 +2457,14 @@ Checks whether the input value is of the **Uint32Array** type. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | Object | Yes| Object to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | Object | Yes | Object to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the input value is of the **Uint32Array** type; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the input value is of the **Uint32Array** type; returns **false** otherwise. | **Example** ```js @@ -2482,14 +2482,14 @@ Checks whether the input value is of the **WeakMap** type. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | Object | Yes| Object to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | Object | Yes | Object to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the input value is of the **WeakMap** type; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the input value is of the **WeakMap** type; returns **false** otherwise. | **Example** ```js @@ -2507,17 +2507,17 @@ Checks whether the input value is of the **WeakSet** type. **System capability**: SystemCapability.Utils.Lang **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| value | Object | Yes| Object to check.| + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | value | Object | Yes | Object to check. | **Return value** -| Type| Description| -| -------- | -------- | -| boolean | Returns **true** if the input value is of the **WeakSet** type; returns **false** otherwise.| + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the input value is of the **WeakSet** type; returns **false** otherwise. | **Example** ```js var that = new util.types(); var result = that.isWeakSet(new WeakSet()); - ``` + ``` \ No newline at end of file