rxjs-native-bridge 1.0.0 → 1.0.11

package/README.md

@@ -6,75 +6,96 @@ js-bridge https://github.com/uknownothingsnow/JsBridge?tab=readme-ov-file
 # 使用
 安装rxjs依赖<br/>
 npm install rxjs-native-bridge<br/>
-### 初始化js-bridge main.js
-import 'rxjs-native-bridge'<br/>
+### 初始化js-bridge main.ts
+```ts
+import 'rxjs-native-bridge'
+```
 ### 扩展
-// import { jsBridge, rxJsBridge, JSBridge, RxJSBridge } from 'rxjs-native-bridge'<br/>
-自定义jsBridge扩展继承 JSBridge<br/>
-自定义RxJSBridge扩展继承 RxJSBridge<br/>
-
+```ts
+// import { jsBridge, rxJsBridge, JSBridge, RxJSBridge } from 'rxjs-native-bridge'
+// 自定义jsBridge扩展继承 JSBridge
+// 自定义RxJSBridge扩展继承 RxJSBridge
+```
  ### 不使用rxjs
+ ```ts
 import { jsBridge } from 'rxjs-native-bridge'<br/>
+```
  #### js调用native
-
+```ts
  jsBridge.callHandler('handlerName', { num: 1 }, res => {
-  console.log(res)
-})
-
+   console.log(res)
+ }): void
+```
  #### js注册方法共native调用
-
+```ts
  jsBridge.registerHandler('handlerName', (params, callback) => {
   console.log('native 参数', params)
   callback({ name: 'hello' })
-})
-
+}): void
+```
 ### 使用rxjs
 安装rxjs依赖<br/>
 npm install rxjs@7.8.2<br/>
-import { rxJsBridge } from 'rxjs-native-bridge'<br/>
 #### js调用native全局回调值拦截器
+```ts
+import { rxJsBridge } from 'rxjs-native-bridge'
 rxJsBridge.useCallInterceptor<{ data: unknown }>(res => {
-  if (!res) throw new Error('native error')
+  if (!res) throw new Error('native error') // 抛出错误后会被订阅者订阅到错误而不是成功
   if (res?.data) return res.data
-})
+}): RxJsBridge 
+```
 #### js调用native
-rxJsBridge.call<{ num: number }, { name: string }>('test', { num: 1 }).subscribe(res => {
+```ts
+rxJsBridge
+.call<{ num: number }, { name: string }>('test', { num: 1 })
+.subscribe(res => {
   console.log(res.name)
 })
-#### js注册方法共native调用
-
-// 模块a注册事件<br/>
-rxJsBridge.register('handlerName')<br/>
-rxJsBridge.setState('handlerName', { name: 'hello' }) // 设置事件得回调参数<br/>
-rxJsBridge.delState('handlerName') // 删除对应函数的回调值，删除后回调为null<br/>
-rxJsBridge.clearState() // 清空所有回调值，回调为null<br/>
-
-// 其他模块监听native调用提供的方法<br/>
+```
+#### js注册方法供native调用
+```ts
+rxJsBridge.register('handlerName'): RxJsBridge // 注册方法供native调用，建议在项目入口统一注册
+// 设置事件的回调参数，可多处覆盖更新，只会回调最新setState的值给native
+rxJsBridge.setState('handlerName', { name: 'hello' }): void
+rxJsBridge.delState('handlerName'): void // 删除对应函数的回调值，删除后回调为null
+rxJsBridge.clearState(): void // 清空所有回调值，回调为null
+// 其他模块监听native调用提供的方法
 const sub = rxJsBridge.on('handlerName').subscribe(({ params }) => {
   console.log('native 传的参数', params)
 })
-
 sub.unsubscribe()  // 取消监听
+```
 ##### 监听执行并自动取消
+```ts
 rxJsBridge.once('handlerName').subscribe(({ params }) => {
   console.log('native 参数', params)
 })
+```
 ###### or
+```ts
 rxJsBridge
   .event('handlerName')
   .pipe(take(1))
   .subscribe(({ params }) => {
     console.log('native 参数', params)
   })
-##### 链式调用
-rxJsBridge
+  // 注意：once和event方法在没有register时会自动注册 register只注册不监听
+```
+##### 同时注册并监听事件
+```ts
+// 链式调用
+const sub = rxJsBridge
  .register('handlerName')
  .on('handlerName')
  .subscribe(({ params }) => {
   console.log('native 参数', params)
 })
-
-##### 同时注册并监听事件
+sub.unsubscribe()  // 取消监听
+// or
+rxJsBridge.once('handlerName').subscribe(({ params }) => {
+  console.log('native 参数', params)
+})
+// or
 const sub = rxJsBridge
 .event('handlerName')
 .subscribe(({ params }) => {
@@ -82,6 +103,6 @@ const sub = rxJsBridge
 })
 
 sub.unsubscribe()  // 取消监听
-
+```
 ### 构建项目
 npm run build

package/package.json

@@ -1,11 +1,19 @@
 {
   "name": "rxjs-native-bridge",
-  "version": "1.0.0",
+  "version": "1.0.11",
   "type": "module",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ztf-git/rxjs-native-bridge"
   },
+  "keywords": [
+    "rxjs-native-bridge",
+    "rxjs",
+    "native",
+    "jsbridge",
+    "javascript",
+    "typescript"
+  ],
   "files": [
     "dist"
   ],