@onekeyfe/react-native-network-throttle 3.0.162-alpha.272 → 3.0.163

package/README.md

@@ -1,5 +1,43 @@
 # @onekeyfe/react-native-network-throttle
 
+Native network throttling configuration for OneKey diagnostics on iOS and
+Android. The wrapper exposes the current configuration and partial updates,
+including latency, bandwidth and the host list used by native throttling.
+
+## Installation and usage
+
+```sh
+yarn add @onekeyfe/react-native-network-throttle
+```
+
+Install the application's iOS pods and rebuild the native application so
+`OneKeyNetworkThrottle` is linked.
+
+```ts
+import { NetworkThrottle } from '@onekeyfe/react-native-network-throttle';
+
+const config = await NetworkThrottle.getConfig();
+// Integrate changes through the application's existing diagnostic controls.
+```
+
+## Configuration API
+
+`getConfig()` returns `enabled`, `profile`, `latencyMs`, `downloadBps`,
+`uploadBps` and `throttleUrlHosts`. The public profile type currently contains
+`slow4g`. Exported constants provide its latency and bandwidth presets.
+
+`setConfig(partialConfig)` reads the current native configuration, merges
+omitted fields and returns the applied configuration. Bandwidth fields use
+bytes per second. An omitted host list from native is normalized to an empty
+array. The interface does not expose individual request progress or completion.
+
+The application owns enabling/disabling diagnostic throttling and should
+validate effects on the actual native request path it uses. A returned config
+is not a measurement of achieved throughput. See [src/index.tsx](src/index.tsx)
+for the public types, constants and native-linking failure behavior.
+
+## Upstream attribution
+
 React Native native network throttle for OneKey iOS and Android development settings.
 
 Current scope is RN HTTP(S) latency and upload/download throughput. It does not

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onekeyfe/react-native-network-throttle",
-  "version": "3.0.162-alpha.272",
+  "version": "3.0.163",
   "description": "react-native-network-throttle",
   "main": "./lib/module/index.js",
   "types": "./lib/typescript/src/index.d.ts",
@@ -47,14 +47,15 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/OneKeyHQ/app-modules/react-native-network-throttle.git"
+    "url": "git+https://github.com/OneKeyHQ/app-modules.git",
+    "directory": "native-modules/react-native-network-throttle"
   },
   "author": "@onekeyhq <huanming@onekey.so> (https://github.com/OneKeyHQ/app-modules)",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/OneKeyHQ/app-modules/react-native-network-throttle/issues"
+    "url": "https://github.com/OneKeyHQ/app-modules/issues"
   },
-  "homepage": "https://github.com/OneKeyHQ/app-modules/react-native-network-throttle#readme",
+  "homepage": "https://github.com/OneKeyHQ/app-modules/tree/main/native-modules/react-native-network-throttle#readme",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },