Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ In that common case the library performs a single `INCR` and `SUBSCRIBE` per str

### Idempotent API


The simplest way to use the library is to let it automatically create Redis connections using environment variables (`REDIS_URL` or `KV_URL`):

```typescript
import { createResumableStreamContext } from "resumable-stream";
import { after } from "next/server";
Expand Down Expand Up @@ -89,6 +92,8 @@ export async function GET(req: NextRequest, { params }: { params: Promise<{ stre

### Usage with ioredis

#### Option 1: Use the ioredis-specific import

If you are using `ioredis` instead of `redis`, you can import from `resumable-stream/ioredis` instead. This changes the default Redis client to `ioredis`.

```typescript
Expand All @@ -100,6 +105,43 @@ const streamContext = createResumableStreamContext({
});
```

#### Option 2: Pass your own ioredis instances

```typescript
import { createResumableStreamContext } from "resumable-stream";
import { Redis } from "ioredis";

// Create ioredis instances
const redis = new Redis("redis://localhost:6379");

const streamContext = createResumableStreamContext({
waitUntil: after,
publisher: redis,
subscriber: redis,
});
```

### Using with node-redis (`redis` package)

You can pass your own Redis clients from the `redis` package:

```typescript
import { createResumableStreamContext } from "resumable-stream";
import { createClient } from "redis";
import { after } from "next/server";

// Create Redis client
const redisClient = createClient({
url: "redis://localhost:6379",
});

const streamContext = createResumableStreamContext({
waitUntil: after,
publisher: redisClient,
subscriber: redisClient,
});
```

## Type Docs

[Type Docs](https://github.com/vercel/resumable-stream/blob/main/docs/README.md)
Expand Down