Skip to content

Commit 6647a8e

Browse files
committed
chore: update documentation to replace npm with pnpm for installation and command execution
1 parent 978aaa9 commit 6647a8e

4 files changed

Lines changed: 23 additions & 23 deletions

File tree

CLAUDE.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ This is `@muniter/queue`, a TypeScript queue system inspired by Yii2-Queue archi
99
## Essential Commands
1010

1111
### Development Commands
12-
- `npm run build` - Build TypeScript to JavaScript
13-
- `npm run dev` - Watch mode for development (TypeScript compiler)
14-
- `npm run lint` - Type checking with TypeScript compiler
15-
- `npm test` - Run all tests with Vitest
12+
- `pnpm run build` - Build TypeScript to JavaScript
13+
- `pnpm run dev` - Watch mode for development (TypeScript compiler)
14+
- `pnpm run lint` - Type checking with TypeScript compiler
15+
- `pnpm test` - Run all tests with Vitest
1616

1717
### Worker Commands
18-
- `npm run queue:worker` - Start a queue worker
19-
- `npm run queue:worker:isolate` - Start worker with job isolation
18+
- `pnpm run queue:worker` - Start a queue worker
19+
- `pnpm run queue:worker:isolate` - Start worker with job isolation
2020

2121
### CLI Worker Options
2222
The CLI worker supports these arguments:

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ A TypeScript queue system inspired by Yii2-Queue architecture, providing a clean
1313
## Installation
1414

1515
```bash
16-
npm install @muniter/queue
16+
pnpm add @muniter/queue
1717
```
1818

1919
For SQS support:
2020
```bash
21-
npm install @muniter/queue @aws-sdk/client-sqs
21+
pnpm add @muniter/queue @aws-sdk/client-sqs
2222
```
2323

2424
## Quick Start
@@ -289,19 +289,19 @@ export class YourDatabaseAdapter implements DatabaseAdapter {
289289

290290
```bash
291291
# Database driver (requires your adapter)
292-
npm run queue:worker -- --driver db
292+
pnpm run queue:worker -- --driver db
293293

294294
# SQS driver
295-
npm run queue:worker -- --driver sqs --queue-url https://sqs.us-east-1.amazonaws.com/123/test
295+
pnpm run queue:worker -- --driver sqs --queue-url https://sqs.us-east-1.amazonaws.com/123/test
296296

297297
# File driver
298-
npm run queue:worker -- --driver file --path ./queue-data
298+
pnpm run queue:worker -- --driver file --path ./queue-data
299299

300300
# Run once and exit
301-
npm run queue:worker -- --no-repeat
301+
pnpm run queue:worker -- --no-repeat
302302

303303
# Custom polling timeout
304-
npm run queue:worker -- --timeout 10
304+
pnpm run queue:worker -- --timeout 10
305305
```
306306

307307
## API Reference
@@ -337,17 +337,17 @@ interface JobMap {
337337
Run the test suite:
338338

339339
```bash
340-
npm test
340+
pnpm test
341341
```
342342

343343
Build the project:
344344
```bash
345-
npm run build
345+
pnpm run build
346346
```
347347

348348
Type checking:
349349
```bash
350-
npm run lint
350+
pnpm run lint
351351
```
352352

353353
## Architecture

example-queue-project/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@ This example shows the **separation of concerns** pattern recommended for produc
2525

2626
1. Install dependencies:
2727
```bash
28-
npm install
28+
pnpm install
2929
```
3030

3131
2. Build the project:
3232
```bash
33-
npm run build
33+
pnpm run build
3434
```
3535

3636
## Usage
@@ -40,7 +40,7 @@ npm run build
4040
In one terminal, start the background workers that will process jobs:
4141

4242
```bash
43-
npm run process-jobs
43+
pnpm run process-jobs
4444
```
4545

4646
This will:
@@ -54,7 +54,7 @@ This will:
5454
In another terminal, add jobs to be processed:
5555

5656
```bash
57-
npm run add-job
57+
pnpm run add-job
5858
```
5959

6060
This will add various types of jobs:
@@ -98,8 +98,8 @@ In a real production environment, you would:
9898

9999
## Try It
100100

101-
1. Start workers: `npm run process-jobs`
102-
2. In another terminal: `npm run add-job`
101+
1. Start workers: `pnpm run process-jobs`
102+
2. In another terminal: `pnpm run add-job`
103103
3. Watch the jobs get processed in real-time!
104104
4. Try adding jobs multiple times to see concurrent processing
105105
5. Stop workers with Ctrl+C

src/drivers/redis.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ interface RedisOperations {
2020
exists(...keys: string[]): Promise<number>;
2121
}
2222

23-
// Type for the redis npm package client (simplified - we'll use duck typing)
23+
// Type for the redis package client (simplified - we'll use duck typing)
2424
export interface RedisClient {
2525
[key: string]: any; // Allow any redis client that has the methods we need
2626
}

0 commit comments

Comments
 (0)