@onion-interceptor/pipes - npm Package Compare versions

Comparing version 0.0.1-beta to 0.0.2-beta

package.json

 {
   "name": "@onion-interceptor/pipes",
-  "version": "0.0.1-beta",
+  "version": "0.0.2-beta",
   "type": "module",
@@ -33,5 +33,5 @@ "description": "onion-interceptor pipes",
   "peerDependencies": {
-    "onion-interceptor": "^0.0.x"
+    "onion-interceptor": "latest"
   },
   "license": "ISC"
 }

README.md

@@ -1,2 +0,96 @@
-onion-interceptor 的一些操作管道
+# @onion-interceptor/pipes
 
+`@onion-interceptor/pipes` 是一个操作管道工具，它允许您以一种更简洁的方式编写请求拦截器。
+
+## 安装
+
+使用 npm 或 yarn 或 pnpm 安装 `@onion-interceptor/pipes` :
+
+```bash
+npm install @onion-interceptor/pipes
+```
+
+或者
+
+```bash
+yarn add @onion-interceptor/pipes
+```
+
+或者
+
+```bash
+pnpm add @onion-interceptor/pipes
+```
+
+## 使用方法
+
+- catchError
+
+```typescript
+import { catchError } from '@onion-interceptor/pipes'
+import type { Next, Context } from 'onion-interceptor'
+
+export async function errorInterceptor(ctx: Context, next: Next) {
+  console.log('errorInterceptor start', ctx)
+  await next(
+    catchError((err) => {
+      console.log(error)
+      return Promise.reject(error)
+    })
+  )
+  console.log('errorInterceptor end', ctx)
+}
+```
+
+- finalize
+
+```typescript
+import { finalize } from '@onion-interceptor/pipes'
+import type { Next, Context } from 'onion-interceptor'
+
+export async function loadingInterceptor(ctx: Context, next: Next) {
+  console.log('loadingInterceptor start', ctx)
+  await next(finally(() => console.log('loadingInterceptor end', ctx)))
+}
+```
+
+- tap
+
+```typescript
+import { tap } from '@onion-interceptor/pipes'
+
+export async function errorInterceptor(ctx: Context, next: Next) {
+  console.log('errorInterceptor start', ctx)
+  await next(
+    tap(
+      (_ctx) => console.log('find error in res', _ctx.res),
+      (error) => {
+        console.log(error)
+        return Promise.reject(error)
+      },
+      () => console.log('errorInterceptor end', ctx)
+    )
+  )
+}
+```
+
+- delay
+
+```typescript
+import type { Next, Context } from 'onion-interceptor'
+import { delay,finalize } from '@onion-interceptor/pipes'
+
+export async function loadingInterceptor(ctx: Context, next: Next) {
+  console.log('loadingInterceptor start', ctx)
+  // 延迟 1 秒才执行
+  await next(delay(1000),finally(() => console.log('loadingInterceptor end', ctx)))
+}
+```
+
+## 贡献
+
+如果你有任何疑问或建议，欢迎提交 issue 或 PR。
+
+## 许可
+
+本项目使用 MIT 许可证。

No alert changes

Improved metrics

Total package byte prevSize

4170

increased by102.72%

Number of lines in readme file

96

increased by3100%

No dependency changes