Skip to content

Commit ab3d134

Browse files
committed
doc: update readme import + format
1 parent ee52244 commit ab3d134

File tree

1 file changed

+32
-32
lines changed

1 file changed

+32
-32
lines changed

README.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,14 @@ You can use `GraphileWorkerModule.forRoot`:
3434

3535
```ts
3636
// src/app.module.ts
37-
import { GraphileWorkerModule } from 'nest-graphile-worker';
38-
import { Module } from '@nestjs/common';
39-
import { AppController } from './app.controller';
37+
import { GraphileWorkerModule } from "nest-graphile-worker";
38+
import { Module } from "@nestjs/common";
39+
import { AppController } from "./app.controller";
4040

4141
@Module({
4242
imports: [
4343
GraphileWorkerModule.forRoot({
44-
connectionString: 'postgres://example:password@postgres/example',
44+
connectionString: "postgres://example:password@postgres/example",
4545
}),
4646
],
4747
controllers: [AppController],
@@ -53,11 +53,11 @@ export class AppModule {}
5353
Or you can use `GraphileWorkerModule.forRootAsync`:
5454

5555
```ts
56-
import { GraphileWorkerModule } from '@app/graphile-worker';
57-
import { Module } from '@nestjs/common';
58-
import { ConfigModule, ConfigService } from '@nestjs/config';
59-
import { AppController } from './app.controller';
60-
import { helloTask } from './hello.task';
56+
import { GraphileWorkerModule } from "nestjs-graphile-worker";
57+
import { Module } from "@nestjs/common";
58+
import { ConfigModule, ConfigService } from "@nestjs/config";
59+
import { AppController } from "./app.controller";
60+
import { helloTask } from "./hello.task";
6161

6262
@Module({
6363
imports: [
@@ -66,7 +66,7 @@ import { helloTask } from './hello.task';
6666
imports: [ConfigModule],
6767
inject: [ConfigService],
6868
useFactory: (config: ConfigService) => ({
69-
connectionString: config.get('PG_CONNECTION'),
69+
connectionString: config.get("PG_CONNECTION"),
7070
taskList: {
7171
hello: helloTask,
7272
},
@@ -84,12 +84,12 @@ export class AppModule {}
8484
To create task you need to define an `@Injectable` class with `@Task(name)` decorator who contains a decorated method `@TaskHandler`:
8585

8686
```ts
87-
import { Injectable, Logger } from '@nestjs/common';
88-
import { Helpers } from 'graphile-worker';
89-
import { Task, TaskHandler } from '../../src/index';
87+
import { Injectable, Logger } from "@nestjs/common";
88+
import type { Helpers } from "graphile-worker";
89+
import { Task, TaskHandler } from "../../src/index";
9090

9191
@Injectable()
92-
@Task('hello')
92+
@Task("hello")
9393
export class HelloTask {
9494
private logger = new Logger(HelloTask.name);
9595

@@ -103,8 +103,8 @@ export class HelloTask {
103103
Then do not forget to register this class as provider in your module:
104104

105105
```ts
106-
import { Module } from '@nestjs/common';
107-
import { HelloTask } from './hello.task';
106+
import { Module } from "@nestjs/common";
107+
import { HelloTask } from "./hello.task";
108108
// ...
109109

110110
@Module({
@@ -124,8 +124,8 @@ export class AppModule {}
124124
You may use `WorkerService`:
125125

126126
```ts
127-
import { WorkerService } from '@app/graphile-worker';
128-
import { Controller, HttpCode, Post } from '@nestjs/common';
127+
import { WorkerService } from "nestjs-graphile-worker";
128+
import { Controller, HttpCode, Post } from "@nestjs/common";
129129

130130
@Controller()
131131
export class AppController {
@@ -134,15 +134,15 @@ export class AppController {
134134
@Post()
135135
@HttpCode(201)
136136
async addJob() {
137-
await this.graphileWorker.addJob('hello', { hello: 'world' });
137+
await this.graphileWorker.addJob("hello", { hello: "world" });
138138
}
139139

140-
@Post('bulk')
140+
@Post("bulk")
141141
@HttpCode(201)
142142
async addJobs() {
143143
const jobs = new Array(100)
144144
.fill(undefined)
145-
.map((_, i) => ({ identifier: 'hello', payload: { hello: i } }));
145+
.map((_, i) => ({ identifier: "hello", payload: { hello: i } }));
146146

147147
return this.graphileWorker.addJobs(jobs);
148148
}
@@ -154,9 +154,9 @@ export class AppController {
154154
Add `WorkerService.run` in `main.ts` file:
155155

156156
```ts
157-
import { WorkerService } from '@app/graphile-worker';
158-
import { NestFactory } from '@nestjs/core';
159-
import { AppModule } from './app.module';
157+
import { WorkerService } from "nestjs-graphile-worker";
158+
import { NestFactory } from "@nestjs/core";
159+
import { AppModule } from "./app.module";
160160

161161
async function bootstrap() {
162162
const app = await NestFactory.create(AppModule);
@@ -168,27 +168,27 @@ bootstrap();
168168

169169
## `OnWorkerEvent` decorator
170170

171-
This decorator allow you to listen all [GRaphile Worker event](https://github.com/graphile/worker#workerevents)
171+
This decorator allow you to listen all [Graphile Worker event](https://github.com/graphile/worker#workerevents)
172172

173173
You need to add `@GraphileWorkerListener` decorator on your class and then set `@OnWorkerEvent(eventName)` on method:
174174

175175
```ts
176-
import { Injectable, Logger } from '@nestjs/common';
177-
import { WorkerEventMap } from 'graphile-worker';
178-
import { GraphileWorkerListener, OnWorkerEvent } from '../../src/index';
176+
import { Injectable, Logger } from "@nestjs/common";
177+
import { WorkerEventMap } from "graphile-worker";
178+
import { GraphileWorkerListener, OnWorkerEvent } from "../../src/index";
179179

180180
@Injectable()
181181
@GraphileWorkerListener()
182182
export class AppService {
183183
private readonly logger = new Logger(AppService.name);
184184

185-
@OnWorkerEvent('job:success')
186-
onJobSuccess({ job }: WorkerEventMap['job:success']) {
185+
@OnWorkerEvent("job:success")
186+
onJobSuccess({ job }: WorkerEventMap["job:success"]) {
187187
this.logger.debug(`job #${job.id} finished`);
188188
}
189189

190-
@OnWorkerEvent('job:error')
191-
onJobError({ job, error }: WorkerEventMap['job:error']) {
190+
@OnWorkerEvent("job:error")
191+
onJobError({ job, error }: WorkerEventMap["job:error"]) {
192192
this.logger.error(`job #${job.id} fail ${JSON.stringify(error)}`);
193193
}
194194
}

0 commit comments

Comments
 (0)