| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | +AsyncCallback<KVManager> + |
+ + | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | +
|---|---|
Promise<KVManager> + |
+ + | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | +
|---|---|---|
| + | ++ | ++ | +
<T extends KVStore> | 是 | 创建KVStore实例的回调，返回KVStore对象实例。 | - -- 示例： - ``` - let kvStore; - try { - const options = { - createIfMissing : true, - encrypt : false, - backup : false, - autoSync : true, - kvStoreType : 1, - securityLevel : 3, - }; - kvManager.getKVStore('storeId', options, function (err, store) { - if (err) { - console.log("getKVStore err: " + JSON.stringify(err)); - return; - } - console.log("getKVStore success"); - kvStore = store; - }); - } catch (e) { - console.log("An unexpected error occurred. Error:" + e); - } - ``` - - -### getKVStore - -getKVStore<T extends KVStore>(storeId: string, options: Options): Promise<T> +- 参数： + + +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | +数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 + |
+
| + | ++ | ++ | ++ | +
| + | ++ + | ++ | ++ | +
<T extends KVStore> | 指定的Promise回调方法，返回创建的KVStore数据库实例。 | - -- 示例： - ``` - let kvStore; - try { - const options = { - createIfMissing : true, - encrypt : false, - backup : false, - autoSync : true, - kvStoreType : 1, - securityLevel : 3, - }; - kvManager.getKVStore('storeId', options).then((store) => { - console.log("getKVStore success"); - kvStore = store; - }).catch((err) => { - console.log("getKVStore err: " + JSON.stringify(err)); - }); - } catch (e) { - console.log("An unexpected error occurred. Error:" + e); - } - ``` - - -## Options +- 参数： + + +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | +数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 + |
+
| + | ++ | ++ | ++ | +
| + | ++ | +
|---|---|
| + + | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | +要关闭的数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 + |
+
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | +要关闭的数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 + |
+
| + | ++ | ++ | ++ | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | +要删除的数据库唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 + |
+
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | +要删除数据库的唯一标识符，长度不大于MAX_STORE_ID_LENGTH。 + |
+
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | + | +
|---|---|---|---|
| + | ++ | ++ | + | +
| + | ++ | ++ | + | +
| + | ++ | ++ | + | +
|---|---|---|---|
| + | ++ | ++ | + | +
| + | ++ | ++ | + | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | +
|---|---|---|
| + | ++ | ++ | +
| + | ++ | ++ | +
| + | ++ | ++ | +
| + | ++ | ++ | +
|---|---|---|
| + | ++ | ++ | +
| + | ++ | ++ | +
| + | ++ | ++ | +
| + | ++ | ++ | +
| + | ++ | ++ | +
| + | ++ | ++ | +
| + | ++ | ++ | +
|---|---|---|
| + | ++ | ++ | +
| + | ++ | ++ | +
| + | ++ | ++ | +
| + | ++ | ++ | +
| + | ++ | ++ | +
| + | ++ | ++ | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | + | +
|---|---|---|---|
| + | ++ | ++ | + | +
| + | ++ | ++ | + | +
|---|---|---|---|
| + | ++ | ++ | + | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | + | +
|---|---|---|---|
| + | ++ | ++ | + |
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | + | +
|---|---|---|---|
| + | ++ | ++ | + |
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | + | +
|---|---|---|---|
| + | ++ | ++ | + | +
| + | ++ | ++ | + | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | + | +
|---|---|---|---|
| + | ++ | ++ | + | +
| + | ++ | ++ | + | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | + | +
|---|---|---|---|
| + | ++ | ++ | + | +
| + | ++ | ++ | + | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | + | +
|---|---|---|---|
| + | ++ | ++ | + | +
| + | ++ | ++ | + | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | + | +
|---|---|---|---|
| + | ++ | ++ | + | +
| + | ++ | ++ | + | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | + | +
|---|---|---|---|
| + | ++ | ++ | + | +
| + | ++ | ++ | + | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | + | +
|---|---|---|---|
| + | ++ | ++ | + | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | + | +
|---|---|---|---|
| + | ++ | ++ | + | +
| + | ++ | ++ | + | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | + | +
|---|---|---|---|
| + | ++ | ++ | + | +
| + | ++ | ++ | + | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | + | +
|---|---|---|---|
| + | ++ | ++ | + | +
| + | ++ | ++ | + | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | + | +
|---|---|---|---|
| + | ++ | ++ | + | +
| + | ++ | ++ | + | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | + | +
|---|---|---|---|
| + | ++ | ++ | + | +
| + | ++ | ++ | + | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | + | +
|---|---|---|---|
| + | ++ | ++ | + | +
| + | ++ | ++ | + | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | + | +
|---|---|---|---|
| + | ++ | ++ | + | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | + | +
|---|---|---|---|
| + | ++ | ++ | + | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | + | +
|---|---|---|---|
| + | ++ | ++ | + | +
| + | ++ | ++ | + | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | + | +
|---|---|---|---|
| + | ++ | ++ | + | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | + | +
|---|---|---|---|
| + | ++ | ++ | + | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | + | +
|---|---|---|---|
| + | ++ | ++ | + | +
| + | ++ | +
|---|---|
| + | ++ | +
Uint8Array、string 的长度不大于[MAX_VALUE_LENGTH](#Constants)。 | - | callback | AsyncCallback<void> | 是 | 回调函数。 | - -- 示例 - ``` - const KEY_TEST_STRING_ELEMENT = 'key_test_string'; - const VALUE_TEST_STRING_ELEMENT = 'value-test-string'; - try { - kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT, function (err,data) { - if (err != undefined) { - console.log("put err: " + JSON.stringify(err)); - return; - } - console.log("put success"); - }); - }catch (e) { - console.log("An unexpected error occurred. Error:" + e); - } - ``` - - -### put - -put(key: string, value: Uint8Array | string | number | boolean): Promise<void> +- 参数： + + +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | +要添加数据的key，不能为空且长度不大于MAX_KEY_LENGTH。 + |
+
| + | ++ | ++ | +要添加数据的value，支持Uint8Array、number 、 string 、boolean， +Uint8Array、string 的长度不大于MAX_VALUE_LENGTH。 + |
+
| + | ++ | ++ | ++ | +
Uint8Array、string 的长度不大于[MAX_VALUE_LENGTH](#Constants)。 | - -- 返回值： - | 类型 | 说明 | - | -------- | -------- | - | Promise<void> | Promise实例，用于异步处理。 | - - -- 示例 - ``` - const KEY_TEST_STRING_ELEMENT = 'key_test_string'; - const VALUE_TEST_STRING_ELEMENT = 'value-test-string'; - try { - kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT).then((data) => { - console.log("put success: " + JSON.stringify(data)); - }).catch((err) => { - console.log("put err: " + JSON.stringify(err)); - }); - }catch (e) { - console.log("An unexpected error occurred. Error:" + e); - } - ``` - - -### delete - -delete(key: string, callback: AsyncCallback<void>): void +- 参数： + + +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | +要添加数据的key，不能为空且长度不大于MAX_KEY_LENGTH。 + |
+
| + | ++ | ++ | +要添加数据的value，支持Uint8Array、number 、 string 、boolean， +Uint8Array、string 的长度不大于MAX_VALUE_LENGTH。 + |
+
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | +要删除数据的key，不能为空且长度不大于MAX_KEY_LENGTH。 + |
+
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | +要删除数据的key，不能为空且长度不大于MAX_KEY_LENGTH。 + |
+
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | +
|---|---|---|
| + | ++ | ++ | +
| + | ++ | ++ | +
| + | +Callback<ChangeNotification> + |
+ + | +
| + | ++ | ++ | +
|---|---|---|
| + | ++ | ++ | +
| + | ++ | ++ | +
| + | ++ | ++ | +
|---|---|---|
| + | ++ | ++ | +
| + | +Callback<ChangeNotification> + |
+ + | +
| + | ++ | ++ | + | +
|---|---|---|---|
| + | +Entry[] + |
+ + | + | +
| + | ++ | ++ | + | +
| + | ++ | ++ | + | +
|---|---|---|---|
| + | +Entry[] + |
+ + | + | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | + | +
|---|---|---|---|
| + | ++ | ++ | + | +
| + | ++ | ++ | + | +
| + | ++ | ++ | + | +
|---|---|---|---|
| + | ++ | ++ | + | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | + | +
|---|---|---|---|
| + | ++ | ++ | + | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | + | +
|---|---|---|---|
| + | ++ | ++ | + | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | + | +
|---|---|---|---|
| + | ++ | ++ | + | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | +
|---|---|---|
| + | ++ | ++ | +
| + | ++ | ++ | +
| + | ++ | ++ | +
| + | ++ | ++ | ++ | ++ | +
|---|---|---|---|---|
| + | +Entry[] + |
++ | ++ | ++ | +
| + | +Entry[] + |
++ | ++ | ++ | +
| + | +Entry[] + |
++ | ++ | ++ | +
| + | ++ | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | ++ | +
|---|---|---|---|---|
| + | ++ | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | ++ | +
|---|---|---|---|---|
| + | ++ | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +值，Uint8Array、string 的长度不大于MAX_VALUE_LENGTH。 + |
+
| + | ++ | ++ | +
|---|---|---|
| + | ++ | ++ | +
| + | ++ | ++ | +
| + | ++ | ++ | +
| + | ++ | ++ | +
| + | ++ | ++ | +
| + | ++ | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | +要查询数据的key，不能为空且长度不大于MAX_KEY_LENGTH。 + |
+
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | +要查询数据的key，不能为空且长度不大于MAX_KEY_LENGTH。 + |
+
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | +AsyncCallback<Entry[]> + |
+ + | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | +
|---|---|
Promise<Entry[]> + |
+ + | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | +AsyncCallback<Entry[]> + |
+ + | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | +
|---|---|
Promise<Entry[]> + |
+ + | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | +AsyncCallback<KvStoreResultSet> + |
+ + | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | +
|---|---|
Promise<KvStoreResultSet> + |
+ + | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | +AsyncCallback<KvStoreResultSet> + |
+ + | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | +
|---|---|
Promise<KvStoreResultSet> + |
+ + | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | +AsyncCallback<SecurityLevel> + |
+ + | ++ | +
| + | ++ | +
|---|---|
Promise<SecurityLevel> + |
+ + | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | +AsyncCallback<Entry[]> + |
+ + | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | +
|---|---|
Promise<Entry[]> + |
+ + | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | +AsyncCallback<Entry[]> + |
+ + | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | +
|---|---|
Promise<Entry[]> + |
+ + | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | +AsyncCallback<Entry[]> + |
+ + | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | +
|---|---|
Promise<Entry[]> + |
+ + | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | +AsyncCallback<KvStoreResultSet> + |
+ + | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | +
|---|---|
Promise<KvStoreResultSet> + |
+ + | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | +AsyncCallback<KvStoreResultSet> + |
+ + | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | +
|---|---|
Promise<KvStoreResultSet> + |
+ + | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | +AsyncCallback<KvStoreResultSet> + |
+ + | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | +
|---|---|
Promise<KvStoreResultSet> + |
+ + | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | +
|---|---|
| + | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
|---|---|---|---|
| + | ++ | ++ | ++ | +
| + | ++ | ++ | ++ | +
| + | ++ | ++ | +
|---|---|---|
| + | ++ | ++ | +
| + | ++ | ++ | +
| + | ++ | ++ | +
- 支持格式：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 | 是 | 否 | 是否显示致命错误。 | -| ignoreBOM | boolean | 是 | 否 | 是否忽略BOM（byte order marker）标记，默认值是false。 | +| ignoreBOM | boolean | 是 | 否 | 是否忽略BOM（byte order marker）标记，默认值为false ，表示解码结果包含BOM标记。 | ### constructor -constructor(encoding?: string, options?: { fatal?: boolean; ignoreBOM?: boolean },) +constructor(encoding?:string, options?:{ fatal?:boolean;ignoreBOM?:boolean }) TextDecoder的构造函数。 @@ -164,21 +168,21 @@ TextDecoder的构造函数。 ### decode -decode(input: Uint8Array, options?:{stream?:false}): string +decode(input: Unit8Array, options?:{stream?:false}):string 通过输入参数解码后输出对应文本。 - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | input | Uint8Array | 是 | 符合格式需要解码的数组。 | + | input | Unit8Array | 是 | 符合格式需要解码的数组。 | | options | Object | 否 | 解码相关选项参数。 | **表2** options | 名称 | 参数类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | stream | boolean | 否 | 在随后的decode()调用中是否跟随附加数据块，如果以块的形式处理数据，则设置为true；如果处理最后的数据块或数据未分块，则设置为false。默认为false。 | + | stream | boolean | 否 | 在随后的decode()调用中是否跟随附加数据块。如果以块的形式处理数据，则设置为true；如果处理最后的数据块或数据未分块，则设置为false。默认为false。 | - 返回值： | 类型 | 说明 | @@ -228,7 +232,7 @@ TextEncoder的构造函数。 ### encode -encode(input?: string): Uint8Array +encode(input?:string):Uint8Array 通过输入参数编码后输出对应文本。 @@ -252,7 +256,7 @@ encode(input?: string): Uint8Array ### encodeInto -encodeInto(input: string, dest: Uint8Array,):{ read: number; written: number } +encodeInto(input:string, dest:Uint8Array, ):{ read:number; written:number } 放置生成的UTF-8编码文本。 @@ -274,3 +278,2054 @@ encodeInto(input: string, dest: Uint8Array,):{ read: number; written: number } this.dest = new Uint8Array(buffer); var result = that.encodeInto("abcd", this.dest); ``` + +## RationalNumber8+ + + +### constructor8+ + +constructor(numerator:number,denominator:number) + +RationalNumber的构造函数。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | numerator | number | 是 | 分子，整数类型。 | + | denominator | number | 是 | 分母，整数类型。 | + +- 示例： + ``` + var rationalNumber = new util.RationalNumber(1,2)； + ``` + + +### createRationalFromString8+ + +static createRationalFromString(rationalString:string):RationalNumber + +基于给定的字符串创建一个RationalNumber对象。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | rationalString | string | 是 | 字符串格式。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | object | 返回有理数类的对象。 | + +- 示例： + ``` + var rationalNumber = new util.RationalNumber(1,2); + var rational = rationalNumer.creatRationalFromString("3/4"); + ``` + + +### compareTo8+ + +compareTo(another:RationalNumber):number + +将当前的RationalNumber对象与给定的对象进行比较。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | another | RationalNumber | 是 | 其他的有理数对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | number | 如果两个对象相等，则返回0；如果给定对象小于当前对象，则返回1；如果给定对象大于当前对象，则返回-1。 | + +- 示例： + ``` + var rationalNumber = new util.RationalNumber(1,2); + var rational = rationalNumer.creatRationalFromString("3/4"); + var result = rationalNumber.compareTo(rational); + ``` + + +### valueOf8+ + +valueOf():number + +以整数形式或者浮点数的形式获取当前RationalNumber对象的值。 + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | number | 返回整数或者浮点数的值。 | + +- 示例： + ``` + var rationalNumber = new util.RationalNumber(1,2); + var result = rationalNumber.valueOf(); + ``` + + +### equals8+ + +equals(obj:Object):boolean + +将当前的RationalNumber对象与给定的对象进行比较是否相等。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | object | Object | 是 | 其他类型对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果给定对象与当前对象相同，则返回true；否则返回false。 | + +- 示例： + ``` + var rationalNumber = new util.RationalNumber(1,2); + var rational = rationalNumer.creatRationalFromString("3/4"); + var result = rationalNumber.equals(rational); + ``` + + +### getCommonDivisor8+ + +static getCommonDivisor(number1:number,number2:number):number + +获取两个指定整数的最大公约数。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | number1 | number | 是 | 整数类型。 | + | number2 | number | 是 | 整数类型。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | number | 返回两个给定数字的最大公约数。 | + +- 示例： + ``` + var rationalNumber = new util.RationalNumber(1,2); + var result = rationalNumber.getCommonDivisor(4,6); + ``` + + +### getNumerator8+ + +getNumerator():number + +获取当前RationalNumber对象的分子。 + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | number | 返回RationalNumber对象的分子的值。 | + +- 示例： + ``` + var rationalNumber = new util.RationalNumber(1,2); + var result = rationalNumber.getNumerator(); + ``` + + +### getDenominator8+ + +getDenominator():number + +获取当前RationalNumber对象的分母。 + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | number | 返回RationalNumber对象的分母的值。 | + +- 示例： + ``` + var rationalNumber = new util.RationalNumber(1,2); + var result = rationalNumber.getDenominator(); + ``` + + +### isZero8+ + +isZero():boolean + +检查当前RationalNumber对象是否为0。 + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果当前对象表示的值为0，则返回true；否则返回false。 | + +- 示例： + ``` + var rationalNumber = new util.RationalNumber(1,2); + var result = rationalNumber.isZero(); + ``` + + +### isNaN8+ + +isNaN():boolean + +检查当前RationalNumber对象是否表示非数字(NaN)值。 + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果分母和分子都为0，则返回true；否则返回false。 | + +- 示例： + ``` + var rationalNumber = new util.RationalNumber(1,2); + var result = rationalNumber.isNaN(); + ``` + + +### isFinite8+ + +isFinite():boolean + +检查当前RationalNumber对象是否表示一个有限值。 + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果分母不为0，则返回true；否则返回false。 | + +- 示例： + ``` + var rationalNumber = new util.RationalNumber(1,2); + var result = rationalNumber.isFinite(); + ``` + + +### toString8+ + +toString():string + +获取当前RationalNumber对象的字符串表示形式。 + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | string | 返回Numerator/Denominator格式的字符串，例如3/5，如果当前对象的分子和分母都为0，则返回NaN。 | + +- 示例： + ``` + var rationalNumber = new util.RationalNumber(1,2); + var result = rationalNumber.toString(); + ``` + +## LruBuffer8+ + + +### 属性 + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| -------- | -------- | -------- | -------- | -------- | +| length | number | 是 | 否 | 当前缓冲区中值的总数。 | + +- 示例： + ``` + var pro = new util.LruBuffer(); + pro.put(2,10); + pro.put(1,8); + var result = pro.length; + ``` + + +### constructor8+ + +constructor(capacity?:number) + +默认构造函数用于创建一个新的LruBuffer实例，默认容量为64。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | capacity | number | 否 | 指示要为缓冲区自定义的容量。 | + +- 示例： + ``` + var lrubuffer= new util.LruBuffer()； + ``` + + +### updateCapacity8+ + +updateCapacity(newCapacity:number):void + +将缓冲区容量更新为指定容量，如果newCapacity小于或等于0，则抛出异常。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | newCapacity | number | 是 | 指示要为缓冲区自定义的容量。 | + +- 示例： + ``` + var pro = new util.LruBuffer(); + var result = pro.updateCapacity(100); + ``` + + +### toString8+ + +toString():string + +返回对象的字符串表示形式。 + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | string | 返回对象的字符串表示形式。 | + +- 示例： + ``` + var pro = new util.LruBuffer(); + pro.put(2,10); + pro.get(2); + pro.remove(20); + var result = pro.toString(); + ``` + + +### getCapacity8+ + +getCapacity():number + +获取当前缓冲区的容量。 + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | number | 返回当前缓冲区的容量。 | + +- 示例： + ``` + var pro = new util.LruBuffer(); + var result = pro.getCapacity(); + ``` + + +### clear8+ + +clear():void + +从当前缓冲区清除键值对。后续会调用afterRemoval()方法执行后续操作。 + +- 示例： + ``` + var pro = new util.LruBuffer(); + pro.put(2,10); + var result = pro.size(); + pro.clear(); + ``` + + +### getCreateCount8+ + +getCreateCount():number + +获取createDefault()返回值的次数。 + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | number | 返回createDefault()返回值的次数。 | + +- 示例： + ``` + var pro = new util.LruBuffer(); + pro.put(1,8); + var result = pro.getCreateCount(); + ``` + + +### getMissCount8+ + +getMissCount():number + +获取查询值不匹配的次数。 + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | number | 返回查询值不匹配的次数。 | + +- 示例： + ``` + var pro = new util.LruBuffer(); + pro.put(2,10); + pro.get(2) + var result = pro.getMissCount(); + ``` + + +### getRemovalCount8+ + +getRemovalCount():number + +获取从缓冲区中逐出值的次数。 + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | number | 返回从缓冲区中驱逐的次数。 | + +- 示例： + ``` + var pro = new util.LruBuffer(); + pro.put(2,10); + pro.updateCapacity(2); + pro.put(50,22); + var result = pro.getRemovalCount(); + ``` + + +### getMatchCount8+ + +getMatchCount():number + +获取查询值匹配成功的次数。 + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | number | 返回查询值匹配成功的次数。 | + +- 示例： + ``` + var pro = new util.LruBuffer(); + pro.put(2,10); + pro.get(2); + var result = pro.getMatchCount(); + ``` + + +### getPutCount8+ + +getPutCount():number + +获取将值添加到缓冲区的次数。 + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | number | 返回将值添加到缓冲区的次数。 | + +- 示例： + ``` + var pro = new util.LruBuffer(); + pro.put(2,10); + var result = pro.getPutCount(); + ``` + + +### isEmpty8+ + +isEmpty():boolean + +检查当前缓冲区是否为空。 + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果当前缓冲区不包含任何值，则返回true。 | + +- 示例： + ``` + var pro = new util.LruBuffer(); + pro.put(2,10); + var result = pro.isEmpty(); + ``` + + +### get8+ + +get(key:K):V | undefined + +表示要查询的键。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | key | K | 是 | 要查询的键。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | V \| undefind | 如果指定的键存在于缓冲区中，则返回与键关联的值；否则返回undefined。 | + +- 示例： + ``` + var pro = new util.LruBuffer(); + pro.put(2,10); + var result = pro.get(2); + ``` + + +### put8+ + +put(key:K,value:V):V + +将键值对添加到缓冲区。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | key | K | 是 | 要添加的密钥。 | + | value | V | 是 | 指示与要添加的键关联的值。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | V | 返回与添加的键关联的值；如果要添加的键已经存在，则返回原始值，如果键或值为空，则抛出此异常。 | + +- 示例： + ``` + var pro = new util.LruBuffer(); + var result = pro.put(2,10); + ``` + + +### values8+ + +values():V[] + +获取当前缓冲区中所有值从最近访问到最近最少访问的顺序列表 。 + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | V [] | 按从最近访问到最近最少访问的顺序返回当前缓冲区中所有值的列表。 | + +- 示例： + ``` + var pro = new util.LruBuffer(); + pro.put(2,10); + pro.put(2,"anhu"); + pro.put("afaf","grfb"); + var result = pro.values(); + ``` + + +### keys8+ + +keys():K[] + +获取当前缓冲区中所有键从最近访问到最近最少访问的升序列表。 + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | K [] | 按升序返回当前缓冲区中所有键的列表，从最近访问到最近最少访问。 | + +- 示例： + ``` + var pro = new util.LruBuffer(); + pro.put(2,10); + var result = pro.keys(); + ``` + + +### remove8+ + +remove(key:K):V | undefined + +从当前缓冲区中删除指定的键及其关联的值。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | key | K | 是 | 要删除的密钥。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | V \| undefind | 返回一个包含已删除键值对的Optional对象；如果key不存在，则返回一个空的Optional对象，如果key为null，则抛出异常。 | + +- 示例： + ``` + var pro = new util.LruBuffer(); + pro.put(2,10); + var result = pro.remove(20); + ``` + + +### afterRemoval8+ + +afterRemoval(isEvict:boolean,key:K,value:V,newValue:V):void + +删除值后执行后续操作。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | isEvict | boolean | 否 | 因容量不足而调用该方法时，参数值为true，其他情况为false。 | + | key | K | 是 | 表示删除的键。 | + | value | V | 是 | 表示删除的值。 | + | newValue | V | 否 | 如果已调用put方法并且要添加的键已经存在，则参数值是关联的新值。其他情况下参数值为空。 | + +- 示例： + ``` + 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]; + } + } + } + ChildLruBuffer.getInstance().afterRemoval(false,10,30,null)； + ``` + + +### contains8+ + +contains(key:K):boolean + +检查当前缓冲区是否包含指定的键。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | key | K | 是 | 表示要检查的键。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果缓冲区包含指定的键，则返回 true。 | + +- 示例： + ``` + var pro = new util.LruBuffer(); + pro.put(2,10); + var result = pro.contains(20); + ``` + + +### createDefault8+ + +createDefault(key:K):V + +如果未计算特定键的值，则执行后续操作，参数表示丢失的键，返回与键关联的值。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | key | K | 是 | 表示丢失的键。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | V | 返回与键关联的值。 | + +- 示例： + ``` + var pro = new util.LruBuffer(); + var result = pro.createDefault(50); + ``` + + +### entries8+ + +entries():IterableIterator<[K,V]> + +允许迭代包含在这个对象中的所有键值对。 + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | [K, V] | 返回一个可迭代数组。 | + +- 示例： + ``` + var pro = new util.LruBuffer(); + pro.put(2,10); + var result = pro.entries(); + ``` + + +### [Symbol.iterator]8+ + +[Symbol.iterator]\(): IterableIterator<[K, V]> + +返回一个键值对形式的二维数组。 + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | [K, V] | 返回一个键值对形式的二维数组。 | + +- 示例： + ``` + var pro = new util.LruBuffer(); + pro.put(2,10); + var result = pro[symbol.iterator](); + ``` + + +## Scope8+ + + +### ScopeType8+ + +用于表示范围中的值的类型。该类型的值，类型可以为ScopeComparable或number。 + +ScopeComparable类型的值需要实现compareTo方法，确保传入的数据具有可比性。 +``` +interface ScopeComparable{ + compareTo(other:ScopeComparable):boolean; +} +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(); + } +} +``` + + +### constructor8+ + +constructor(lowerObj:ScopeType,upperObje:ScopeType) + +用于创建指定下限和上限的作用域实例的构造函数，返回一个Scope对象。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | lowerObj | [ScopeType](#scopetype8) | 是 | 指定作用域实例的下限。 | + | upperObj | [ScopeType](#scopetype8) | 是 | 指定作用域实例的上限。 | + +- 示例： + ``` + var tempLower = new Temperature(30); + var tempUpper = new Temperature(40); + var range = new util.Scope(tempLower, tempUpper); + ``` + + +### toString8+ + +toString():string + +该字符串化方法返回一个包含当前范围的字符串表示形式。 + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | string | 返回包含当前范围对象的字符串表示形式。 | + +- 示例： + ``` + var tempLower = new Temperature(30); + var tempUpper = new Temperature(40); + var range = new util.Scope(tempLower, tempUpper); + var result = range.toString(); + ``` + + +### intersect8+ + +intersect(range:Scope):Scope + +获取给定范围和当前范围的交集。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | range | [Scope](#scope8) | 是 | 传入一个给定范围。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | [Scope](#scope8) | 返回给定范围和当前范围的交集。 | + +- 示例： + ``` + 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 ); + ``` + + +### intersect8+ + +intersect(lowerObj:ScopeType,upperObj:ScopeType):Scope + +获取当前范围与给定下限和上限范围的交集。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | lowerObj | [ScopeType](#scopetype8) | 是 | 给定范围的下限。 | + | upperObj | [ScopeType](#scopetype8) | 是 | 给定范围的上限。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | [Scope](#scope8) | 返回当前范围与给定下限和上限范围的交集。 | + +- 示例： + ``` + 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 result = range.intersect(tempMiDF, tempMidS)； + ``` + + +### getUpper8+ + +getUpper():ScopeType + +获取当前范围的上限。 + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | [ScopeType](#scopetype8) | 返回当前范围的上限值。 | + +- 示例： + ``` + var tempLower = new Temperature(30); + var tempUpper = new Temperature(40); + var range = new util.Scope(tempLower, tempUpper); + var result = range.getUpper()； + ``` + + +### getLower8+ + +getLower():ScopeType + +获取当前范围的下限。 + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | [ScopeType](#scopetype8) | 返回当前范围的下限值。 | + +- 示例： + ``` + var tempLower = new Temperature(30); + var tempUpper = new Temperature(40); + var range = new util.Scope(tempLower, tempUpper); + var result = range.getLower()； + ``` + + +### expand8+ + +expand(lowerObj:ScopeType,upperObj:ScopeType):Scope + +创建并返回包括当前范围和给定下限和上限的并集。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | lowerObj | [ScopeType](#scopetype8) | 是 | 给定范围的下限。 | + | upperObj | [ScopeType](#scopetype8) | 是 | 给定范围的上限。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | [Scope](#scope8) | 返回当前范围和给定下限和上限的并集。 | + +- 示例： + ``` + 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 result = range.expand(tempMiDF, tempMidS)； + ``` + + +### expand8+ + +expand(range:Scope):Scope + +创建并返回包括当前范围和给定范围的并集。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | range | [Scope](#scope8) | 是 | 传入一个给定范围。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | [Scope](#scope8) | 返回包括当前范围和给定范围的并集。 | + +- 示例： + ``` + 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); + var result = range.expand(rangeFir)； + ``` + + +### expand8+ + +expand(value:ScopeType):Scope + +创建并返回包括当前范围和给定值的并集。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | [ScopeType](#scopetype8) | 是 | 传入一个给定值。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | [Scope](#scope8) | 返回包括当前范围和给定值的并集。 | + +- 示例： + ``` + var tempLower = new Temperature(30); + var tempUpper = new Temperature(40); + var tempMiDF = new Temperature(35); + var range = new util.Scope(tempLower, tempUpper); + var result = range.expand(tempMiDF)； + ``` + + +### contains8+ + +contains(value:ScopeType):boolean + +检查给定value是否包含在当前范围内。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | [ScopeType](#scopetype8) | 是 | 传入一个给定值。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果给定值包含在当前范围内返回true，否则返回false。 | + +- 示例： + ``` + var tempLower = new Temperature(30); + var tempUpper = new Temperature(40); + var tempMiDF = new Temperature(35); + var range = new util.Scope(tempLower, tempUpper); + range.contains(tempMiDF)； + ``` + + +### contains8+ + +contains(range:Scope):boolean + +检查给定range是否在当前范围内。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | range | [Scope](#scope8) | 是 | 传入一个给定范围。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果给定范围包含在当前范围内返回true，否则返回false。 | + +- 示例： + ``` + 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); + var result = range.contains(rangeSec)； + ``` + + +### clamp8+ + +clamp(value:ScopeType):ScopeType + +将给定值限定到当前范围内。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | [ScopeType](#scopetype8) | 是 | 传入的给定值。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | [ScopeType](#scopetype8) | 如果传入的value小于下限，则返回lowerObj；如果大于上限值则返回upperObj；如果在当前范围内，则返回value | + +- 示例： + ``` + var tempLower = new Temperature(30); + var tempUpper = new Temperature(40); + var tempMiDF = new Temperature(35); + var range = new util.Scope(tempLower, tempUpper); + var result = range.clamp(tempMiDF)； + ``` + + +## Base648+ + + +### constructor8+ + +constructor() + +Base64的构造函数。 + +- 示例： + ``` + var base64 = new util.Base64()； + ``` + + +### encodeSync8+ + +encodeSync(src:Uint8Array):Uint8Array + +通过输入参数编码后输出对应文本。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | src | Uint8Array | 是 | 编码输入Uint8数组。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | Uint8Array | 返回编码后新分配的Uint8数组。 | + +- 示例： + ``` + var that = new util.Base64(); + var array = new Uint8Array([115,49,51]); + var result = that.encodeSync(array); + ``` + + +### encodeToStringSync8+ + +encodeToStringSync(src:Uint8Array):string + +通过输入参数编码后输出对应文本。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | src | Uint8Array | 是 | 编码输入Uint8数组。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | string | 返回编码后的字符串。 | + +- 示例： + ``` + var that = new util.Base64(); + var array = new Uint8Array([115,49,51]); + var result = that.encodeToStringSync(array); + ``` + + +### decodeSync8+ + +decodeSync(src:Uint8Array | string):Uint8Array + +通过输入参数解码后输出对应文本。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | src | Uint8Array \| string | 是 | 解码输入Uint8数组或者字符串。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | Uint8Array | 返回解码后新分配的Uint8数组。 | + +- 示例： + ``` + var that = new util.Base64(); + var buff = 'czEz'; + var result = that.decodeSync(buff); + ``` + + +### encode8+ + +encode(src:Uint8Array):Promise<Uint8Array> + +通过输入参数异步编码后输出对应文本。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | src | Uint8Array | 是 | 异步编码输入Uint8数组。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | Promise<Uint8Array> | 返回异步编码后新分配的Uint8数组。 | + +- 示例： + ``` + var that = new util.Base64(); + var array = new Uint8Array([115,49,51]); + var rarray = new Uint8Array([99,122,69,122]); + await that.encode(array).then(val=>{ + for (var i = 0; i < rarray.length; i++) { + expect(val[i]).assertEqual(rarray[i]) + } + }) + done(); + ``` + + +### encodeToString8+ + +encodeToString(src:Uint8Array):Promise<string> + +通过输入参数异步编码后输出对应文本。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | src | Uint8Array | 是 | 异步编码输入Uint8数组。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | Promise<string> | 返回异步编码后的字符串。 | + +- 示例： + ``` + var that = new util.Base64(); + var array = new Uint8Array([115,49,51]); + await that.encodeToString(array).then(val=>{ + expect(val).assertEqual('czEz') + }) + done(); + ``` + + +### decode8+ + +decode(src:Uint8Array | string):Promise<Uint8Array> + +通过输入参数异步解码后输出对应文本。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | src | Uint8Array \| string | 是 | 异步解码输入Uint8数组或者字符串。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | Promise<Uint8Array> | 返回异步解码后新分配的Uint8数组。 | + +- 示例： + ``` + var that = new util.Base64(); + var array = new Uint8Array([99,122,69,122]); + var rarray = new Uint8Array([115,49,51]); + await that.decode(array).then(val=>{ + for (var i = 0; i < rarray.length; i++) { + expect(val[i]).assertEqual(rarray[i]) + } + }) + done(); + ``` + + +## Types8+ + + +### constructor8+ + +constructor() + +Types的构造函数。 + +- 示例： + ``` + var type = new util.Types()； + ``` + + +### isAnyArrayBuffer8+ + +isAnyArrayBuffer(value: Object):boolean + +检查输入的value是否是ArrayBuffer类型。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | Object | 是 | 待检测对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断的结果，如果是ArrayBuffer类型为true，反之为false。 | + +- 示例： + ``` + var that = new util.Types(); + var result = that.isAnyArrayBuffer(new ArrayBuffer([])); + ``` + + +### isArrayBufferView8+ + +isArrayBufferView(value: Object):boolean + +检查输入的value是否是内置ArrayBufferView辅助类型。 + +ArrayBufferView辅助类型包括：Int8Array、Uint8Array、Uint8ClampedArray、Int16Array、Int16Array、Int32Array、Uint32Array、Float32Array、Float64Array、DataView。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | Object | 是 | 待检测对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断的结果，如果是内置包含的ArrayBufferView辅助类型为true，反之为false。 | + +- 示例： + ``` + var that = new util.Types(); + var result = that.isArrayBufferView(new Int8Array([])); + ``` + + +### isArgumentsObject8+ + +isArgumentsObject(value: Object):boolean + +检查输入的value是否是一个arguments对象类型。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | Object | 是 | 待检测对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断的结果，如果是内置包含的arguments类型为true，反之为false。 | + +- 示例： + ``` + var that = new util.Types(); + function foo() { + var result = that.isArgumentsObject(arguments); + } + var f = foo(); + ``` + + +### isArrayBuffer8+ + +isArrayBuffer(value: Object):boolean + +检查输入的value是否是一个ArrayBuffer对象类型。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | Object | 是 | 待检测对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断的结果，如果是内置包含的ArrayBuffer类型为true，反之为false。 | + +- 示例： + ``` + var that = new util.Types(); + var result = that.isArrayBuffer(new ArrayBuffer([])); + ``` + + +### isAsyncFunction8+ + +isAsyncFunction(value: Object):boolean + +检查输入的value是否是一个异步函数类型。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | Object | 是 | 待检测对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断的结果，如果是内置包含的异步函数类型为true，反之为false。 | + +- 示例： + ``` + var that = new util.Types(); + var result = that.isAsyncFunction(async function foo() {}); + ``` + + +### isBooleanObject8+ + +isBooleanObject(value: Object):boolean + +检查输入的value是否是一个Boolean对象类型。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | Object | 是 | 待检测对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断的结果，如果是内置包含的Boolean对象类型为true，反之为false。 | + +- 示例： + ``` + var that = new util.Types(); + var result = that.isBooleanObject(new Boolean(true)); + ``` + + +### isBoxedPrimitive8+ + +isBoxedPrimitive(value: Object):boolean + +检查输入的value是否是Boolean或Number或String或Symbol对象类型。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | Object | 是 | 待检测对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断的结果，如果是内置包含的Boolean或Number或String或Symbol对象类型为true，反之为false。 | + +- 示例： + ``` + var that = new util.Types(); + var result = that.isBoxedPrimitive(new Boolean(false)); + ``` + + +### isDataView8+ + +isDataView(value: Object):boolean + +检查输入的value是否是DataView类型。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | Object | 是 | 待检测对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断的结果，如果是内置包含的DataView对象类型为true，反之为false。 | + +- 示例： + ``` + var that = new util.Types(); + const ab = new ArrayBuffer(20); + var result = that.isDataView(new DataView(ab)); + ``` + + +### isDate8+ + +isDate(value: Object):boolean + +检查输入的value是否是Date类型。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | Object | 是 | 待检测对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断的结果，如果是内置包含的Date对象类型为true，反之为false。 | + +- 示例： + ``` + var that = new util.Types(); + var result = that.isDate(new Date()); + ``` + + +### isExternal8+ + +isExternal(value: Object):boolean + +检查输入的value是否是native External类型。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | Object | 是 | 待检测对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断的结果，如果是内置包含native External类型为true，反之为false。 | + +- 示例： + ``` + var that = new util.Types(); + const data = util.createExternalType(); + var result = that.isExternal(data); + ``` + + +### isFloat32Array8+ + +isFloat32Array(value: Object):boolean + +检查输入的value是否是Float32Array数组类型。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | Object | 是 | 待检测对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断的结果，如果是内置包含的Float32Array数组类型为true，反之为false。 | + +- 示例： + ``` + var that = new util.Types(); + var result = that.isFloat32Array(new Float32Array()); + ``` + + +### isFloat64Array8+ + +isFloat64Array(value: Object):boolean + +检查输入的value是否是Float64Array数组类型。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | Object | 是 | 待检测对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断的结果，如果是内置包含的Float64Array数组类型为true，反之为false。 | + +- 示例： + ``` + var that = new util.Types(); + var result = that.isFloat64Array(new Float64Array()); + ``` + + +### isGeneratorFunction8+ + +isGeneratorFunction(value: Object):boolean + +检查输入的value是否是generator函数类型。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | Object | 是 | 待检测对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断的结果，如果是内置包含的generator函数类型为true，反之为false。 | + +- 示例： + ``` + var that = new util.Types(); + var result = that.isGeneratorFunction(function* foo() {}); + ``` + + +### isGeneratorObject8+ + +isGeneratorObject(value: Object):boolean + +检查输入的value是否是generator对象类型。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | Object | 是 | 待检测对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断的结果，如果是内置包含的generator对象类型为true，反之为false。 | + +- 示例： + ``` + var that = new util.Types(); + function* foo() {} + const generator = foo(); + var result = that.isGeneratorObject(generator); + ``` + + +### isInt8Array8+ + +isInt8Array(value: Object):boolean + +检查输入的value是否是Int8Array数组类型。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | Object | 是 | 待检测对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断的结果，如果是内置包含的Int8Array数组类型为true，反之为false。 | + +- 示例： + ``` + var that = new util.Types(); + var result = that.isInt8Array(new Int8Array([])); + ``` + + +### isInt16Array8+ + +isInt16Array(value: Object):boolean + +检查输入的value是否是Int16Array数组类型。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | Object | 是 | 待检测对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断的结果，如果是内置包含的Int16Array数组类型为true，反之为false。 | + +- 示例： + ``` + var that = new util.Types(); + var result = that.isInt16Array(new Int16Array([])); + ``` + + +### isInt32Array8+ + +isInt32Array(value: Object):boolean + +检查输入的value是否是Int32Array数组类型。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | Object | 是 | 待检测对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断的结果，如果是内置包含的Int32Array数组类型为true，反之为false。 | + +- 示例： + ``` + var that = new util.Types(); + var result = that.isInt32Array(new Int32Array([])); + ``` + + +### isMap8+ + +isMap(value: Object):boolean + +检查输入的value是否是Map类型。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | Object | 是 | 待检测对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断的结果，如果是内置包含的Map类型为true，反之为false。 | + +- 示例： + ``` + var that = new util.Types(); + var result = that.isMap(new Map()); + ``` + + +### isMapIterator8+ + +isMapIterator(value: Object):boolean + +检查输入的value是否是Map的Iterator类型。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | Object | 是 | 待检测对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断的结果，如果是内置包含的Map的Iterator类型为true，反之为false。 | + +- 示例： + ``` + var that = new util.Types(); + const map = new Map(); + var result = that.isMapIterator(map.keys()); + ``` + + +### isNativeError8+ + +isNativeError(value: Object):boolean + +检查输入的value是否是Error类型。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | Object | 是 | 待检测对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断的结果，如果是内置包含的Error类型为true，反之为false。 | + +- 示例： + ``` + var that = new util.Types(); + var result = that.isNativeError(new TypeError()); + ``` + + +### isNumberObject8+ + +isNumberObject(value: Object):boolean + +检查输入的value是否是Number对象类型。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | Object | 是 | 待检测对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断的结果，如果是内置包含的Number对象类型为true，反之为false。 | + +- 示例： + ``` + var that = new util.Types(); + var result = that.isNumberObject(new Number(0)); + ``` + + +### isPromise8+ + +isPromise(value: Object):boolean + +检查输入的value是否是Promise类型。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | Object | 是 | 待检测对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断的结果，如果是内置包含的Promise类型为true，反之为false。 | + +- 示例： + ``` + var that = new util.Types(); + var result = that.isPromise(Promise.resolve(1)); + ``` + + +### isProxy8+ + +isProxy(value: Object):boolean + +检查输入的value是否是Proxy类型。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | Object | 是 | 待检测对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断的结果，如果是内置包含的Proxy类型为true，反之为false。 | + +- 示例： + ``` + var that = new util.Types(); + const target = {}; + const proxy = new Proxy(target, {}); + var result = that.isProxy(proxy); + ``` + + +### isRegExp8+ + +isRegExp(value: Object):boolean + +检查输入的value是否是RegExp类型。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | Object | 是 | 待检测对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断的结果，如果是内置包含的RegExp类型为true，反之为false。 | + +- 示例： + ``` + var that = new util.Types(); + var result = that.isRegExp(new RegExp('abc')); + ``` + + +### isSet8+ + +isSet(value: Object):boolean + +检查输入的value是否是Set类型。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | Object | 是 | 待检测对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断的结果，如果是内置包含的Set类型为true，反之为false。 | + +- 示例： + ``` + var that = new util.Types(); + var result = that.isSet(new Set()); + ``` + + +### isSetIterator8+ + +isSetIterator(value: Object):boolean + +检查输入的value是否是Set的Iterator类型。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | Object | 是 | 待检测对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断的结果，如果是内置包含的Set的Iterator类型为true，反之为false。 | + +- 示例： + ``` + var that = new util.Types(); + const set = new Set(); + var result = that.isSetIterator(set.keys()); + ``` + + +### isStringObject8+ + +isStringObject(value: Object):boolean + +检查输入的value是否是String对象类型。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | Object | 是 | 待检测对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断的结果，如果是内置包含的String对象类型为true，反之为false。 | + +- 示例： + ``` + var that = new util.Types(); + var result = that.isStringObject(new String('foo')); + ``` + + +### isSymbolObjec8+ + +isSymbolObjec(value: Object):boolean + +检查输入的value是否是Symbol对象类型。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | Object | 是 | 待检测对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断的结果，如果是内置包含的Symbol对象类型为true，反之为false。 | + +- 示例： + ``` + var that = new util.Types(); + const symbols = Symbol('foo'); + var result = that.isSymbolObject(Object(symbols)); + ``` + + +### isTypedArray8+ + +isTypedArray(value: Object):boolean + +检查输入的value是否是TypedArray类型的辅助类型。 + +TypedArray类型的辅助类型，包括Int8Array、Uint8Array、Uint8ClampedArray、Int16Array、Uint16Array、Int32Array、Uint32Array、Float32Array、Float64Array、DataView。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | Object | 是 | 待检测对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断的结果，如果是内置包含的TypedArray包含的类型为true，反之为false。 | + +- 示例： + ``` + var that = new util.Types(); + var result = that.isTypedArray(new Float64Array([])); + ``` + + +### isUint8Array8+ + +isUint8Array(value: Object):boolean + +检查输入的value是否是Uint8Array数组类型。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | Object | 是 | 待检测对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断的结果，如果是内置包含的Uint8Array数组类型为true，反之为false。 | + +- 示例： + ``` + var that = new util.Types(); + var result = that.isUint8Array(new Uint8Array([])); + ``` + + +### isUint8ClampedArray8+ + +isUint8ClampedArray(value: Object):boolean + +检查输入的value是否是Uint8ClampedArray数组类型。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | Object | 是 | 待检测对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断的结果，如果是内置包含的Uint8ClampedArray数组类型为true，反之为false。 | + +- 示例： + ``` + var that = new util.Types(); + var result = that.isUint8ClampedArray(new Uint8ClampedArray([])); + ``` + + +### isUint16Array8+ + +isUint16Array(value: Object):boolean + +检查输入的value是否是Uint16Array数组类型。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | Object | 是 | 待检测对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断的结果，如果是内置包含的Uint16Array数组类型为true，反之为false。 | + +- 示例： + ``` + var that = new util.Types(); + var result = that.isUint16Array(new Uint16Array([])); + ``` + + +### isUint32Array8+ + +isUint32Array(value: Object):boolean + +检查输入的value是否是Uint32Array数组类型。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | Object | 是 | 待检测对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断的结果，如果是内置包含的Uint32Array数组类型为true，反之为false。 | + +- 示例： + ``` + var that = new util.Types(); + var result = that.isUint32Array(new Uint32Array([])); + ``` + + +### isWeakMap8+ + +isWeakMap(value: Object):boolean + +检查输入的value是否是WeakMap类型。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | Object | 是 | 待检测对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断的结果，如果是内置包含的WeakMap类型为true，反之为false。 | + +- 示例： + ``` + var that = new util.Types(); + var result = that.isWeakMap(new WeakMap()); + ``` + + +### isWeakSet8+ + +isWeakSet(value: Object):boolean + +检查输入的value是否是WeakSet类型。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | value | Object | 是 | 待检测对象。 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断的结果，如果是内置包含的WeakSet类型为true，反之为false。 | + +- 示例： + ``` + var that = new util.Types(); + var result = that.isWeakSet(new WeakSet()); + ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-wifi.md b/zh-cn/application-dev/reference/apis/js-apis-wifi.md index 512732d38636d4dd1b8f1ee89dab0d43e4df1d39..a790cd76c5855ea3784c7397a38659729b7d676c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-wifi.md +++ b/zh-cn/application-dev/reference/apis/js-apis-wifi.md @@ -3,23 +3,122 @@ >  **说明：** > 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -## 导入模块 + +## 导入模块 ``` -import wifi from '@ohos.wifi_native_js'; +import wifi from '@ohos.wifi'; ``` + ## wifi.isWifiActive isWifiActive(): boolean 查询WLAN是否已激活。 -**返回值：** +- 返回值： + | **类型** | **说明** | + | -------- | -------- | + | boolean | true:已激活， false:未激活。 | + + +## wifi.scan + +scan(): boolean + +启动WLAN扫描。 + +- 返回值： + | **类型** | **说明** | + | -------- | -------- | + | boolean | true:扫描操作成功， false:扫描操作执行失败。 | + + +## wifi.getScanInfos + +getScanInfos(): Promise<Array<WifiScanInfo>> + +获取扫描结果，使用promise方式作为异步方法。 + +- 返回值： + | **类型** | **说明** | + | -------- | -------- | + | Promise< Array<[WifiScanInfo](#wifiscaninfo)> > | 返回扫描到的热点列表。 | + + +## wifi.getScanInfos + +getScanInfos(callback: AsyncCallback<Array<WifiScanInfo>>): void + +获取扫描结果，使用callback方式作为异步方法。 + +- 参数 + | **参数名** | **类型** | **必填** | **说明** | + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback< Array<[WifiScanInfo](#wifiscaninfo)>> | 是 | 扫描到的热点列表结果回调函数。 | + +- 示例 + ``` + import wifi from '@ohos.wifi'; + + wifi.getScanInfos(result => { + var len = Object.keys(result).length; + console.log("wifi received scan info call back: " + len); + for (var i = 0; i < len; ++i) { + console.info("ssid: " + result[i].ssid); + console.info("bssid: " + result[i].bssid); + console.info("securityType: " + result[i].securityType); + console.info("rssi: " + result[i].rssi); + console.info("band: " + result[i].band); + console.info("frequency: " + result[i].frequency); + console.info("timestamp: " + result[i].timestamp); + } + }); + + wifi.getScanInfos().then(result => { + var len = Object.keys(result).length; + console.log("wifi received scan info promise: " + len); + for (var i = 0; i < len; ++i) { + console.info("ssid: " + result[i].ssid); + console.info("bssid: " + result[i].bssid); + console.info("securityType: " + result[i].securityType); + console.info("rssi: " + result[i].rssi); + console.info("band: " + result[i].band); + console.info("frequency: " + result[i].frequency); + console.info("timestamp: " + result[i].timestamp); + } + }); + ``` + + +## WifiScanInfo + +WLAN热点信息。 + +| **参数名** | **类型** | **读写属性** | **说明** | +| -------- | -------- | -------- | -------- | +| ssid | string | 只读 | 热点的SSID，编码格式为UTF-8。 | +| bssid | string | 只读 | 热点的BSSID。 | +| securityType | [WifiSecurityType](#wifisecuritytype) | 只读 | WLAN加密类型。 | +| rssi | number | 只读 | 热点的信号强度(dBm)。 | +| band | number | 只读 | WLAN接入点的频段。 | +| frequency | number | 只读 | WLAN接入点的频率。 | +| timestamp | number | 只读 | 时间戳。 | + + +## WifiSecurityType + +表示加密类型的枚举。 + +| **名称** | **默认值** | **说明** | +| -------- | -------- | -------- | +| WIFI_SEC_TYPE_INVALID | 0 | 无效加密类型。 | +| WIFI_SEC_TYPE_OPEN | 1 | 开放加密类型。 | +| WIFI_SEC_TYPE_WEP | 2 | Wired Equivalent Privacy (WEP)加密类型。 | +| WIFI_SEC_TYPE_PSK | 3 | Pre-shared key (PSK)加密类型。 | +| WIFI_SEC_TYPE_SAE | 4 | Simultaneous Authentication of Equals (SAE)加密类型。 | -| **类型** | **说明** | -| -------- | ---------------------------- | -| boolean | true:已激活， false:未激活。 | ## wifi.getSignalLevel @@ -27,98 +126,347 @@ getSignalLevel(rssi: number, band: number): number 查询WLAN信号强度。 -**参数：** +- 参数： + | **参数名** | **类型** | **必填** | **说明** | + | -------- | -------- | -------- | -------- | + | rssi | number | 是 | 热点的信号强度(dBm)。 | + | band | number | 是 | WLAN接入点的频段。 | -| **参数名** | **类型** | **必填** | **说明** | -| ---------- | -------- | -------- | --------------------- | -| rssi | number | 是 | 热点的信号强度(dBm)。 | -| band | number | 是 | WLAN接入点的频段。 | +- 返回值： + | **类型** | **说明** | + | -------- | -------- | + | number | 信号强度，取值范围为[0, 4]。 | -**返回值：** -| **类型** | **说明** | -| -------- | ---------------------------- | -| number | 信号强度，取值范围为[0, 4]。 | +## wifi.getIpInfo7+ -## wifi.scan +getIpInfo(): IpInfo -scan(): boolean +获取IP信息。 -启动WLAN扫描。 +- 返回值： + | **类型** | **说明** | + | -------- | -------- | + | [IpInfo](#ipinfo) | 返回IP信息。 | -**返回值：** -| **类型** | **说明** | -| -------- | -------------------------------------------- | -| boolean | true:扫描操作成功， false:扫描操作执行失败。 | +## IpInfo -## wifi.getScanInfos +IP信息。 -getScanInfos(): Promise
- type为'keyboardHeightChange'时表示监听类型为键盘高度变化监听；
- type为'windowSizeChange'7+时表示监听类型为窗口尺寸变化监听；
- type为'systemAvoidAreaChange'7+时表示监听类型为系统窗口规避区变化监听。 | - | callback | Callback<[AvoidArea](#avoidarea7-) \| Size \| number> | 是 | 回调返回监听到的信息。 | + | callback | Callback<[AvoidArea](#avoidarea) \| [Size](#size) \| number> | 是 | 回调返回监听到的信息。 | - 示例 ``` @@ -924,7 +948,7 @@ off(type: string, callback?: Callback<AvoidArea | Size | number>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | type | string | 是 | 设置监听类型。
- type为'keyboardHeightChange'时表示监听类型为键盘高度变化监听；
- type为'windowSizeChange'7+时表示监听类型为窗口尺寸变化监听；
- type为'systemAvoidAreaChange'7+时表示监听类型为系统窗口规避区变化监听。 | - | callback | Callback<[AvoidArea](#avoidarea7-) \| Size \| number> | 否 | 回调返回监听到的信息。 | + | callback | Callback<[AvoidArea](#avoidarea) \| [Size](#size) \| number> | 否 | 回调返回监听到的信息。 | - 示例 ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-xml.md b/zh-cn/application-dev/reference/apis/js-apis-xml.md new file mode 100644 index 0000000000000000000000000000000000000000..ab941b90410da1cfc263da8c126cd8c1f2037d98 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-xml.md @@ -0,0 +1,561 @@ +# xml文本转换 + +>  **说明：** +> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + + +## 导入模块 + +``` +import convertXml from '@ohos.convertxml' +``` + + +## 权限 + +无 + + +## ConvertXML + + +### convert + +convert(xml: string, options?: ConvertOptions) : Object + +转化xml文本为JavaScript对象。 + + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | xml | string | 是 | 传入的xml文本, | + | options | [ConvertOptions](#convertoptions) | 否 | 用户可进行的选项 | + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | string | 处理后返回的JavaScript对象。 | + +- 示例： + ``` + import convertXml from '@ohos.convertxml' + var xml = + '' + + '
| @@ -29,9 +28,8 @@ |
|---|
@@ -56,7 +54,6 @@
**表 1** 当前支持的颜色枚举
-
|
|---|
