doc(module): add examples

Author: madeindjs

libs/graphile-worker/src/graphile-worker.module.ts

@@ -15,6 +15,17 @@ export const GRAPHILE_WORKER_TOKEN = Symbol.for('NestJsGraphileWorker');
 export class GraphileWorkerModule {
   /**
    * Registers a globally available `GraphileWorkerService`.
+   *
+   * Example:
+   *
+   * ```ts
+   *  GraphileWorkerModule.forRoot({
+   *   connectionString: 'postgres://example:password@postgres/example',
+   *   taskList: {
+   *     hello: helloTask,
+   *   },
+   *  }),
+   * ```
    */
   static forRoot(config: GraphileWorkerConfiguration): DynamicModule {
     const graphileWorkerService: Provider = {
@@ -30,6 +41,24 @@ export class GraphileWorkerModule {
     };
   }
 
+  /**
+   * Registers a globally available `GraphileWorkerService`.
+   *
+   * Example:
+   *
+   * ```ts
+   * GraphileWorkerModule.forRootAsync({
+   *   imports: [ConfigModule],
+   *   inject: [ConfigService],
+   *   useFactory: (config: ConfigService) => ({
+   *     connectionString: config.get('PG_CONNECTION'),
+   *     taskList: {
+   *       hello: helloTask,
+   *     },
+   *   }),
+   *  }),
+   * ```
+   */
   static forRootAsync(
     asyncConfig: GraphileWorkerAsyncConfiguration,
   ): DynamicModule {

src/app.module.ts

@@ -6,12 +6,12 @@ import { helloTask } from './hello.task';
 
 @Module({
   imports: [
-    // GraphileWorkerModule.forRoot({
-    //   connectionString: 'postgres://example:password@postgres/example',
-    //   taskList: {
-    //     hello: helloTask,
-    //   },
-    // }),
+    GraphileWorkerModule.forRoot({
+      connectionString: 'postgres://example:password@postgres/example',
+      taskList: {
+        hello: helloTask,
+      },
+    }),
     ConfigModule.forRoot(),
     GraphileWorkerModule.forRootAsync({
       imports: [ConfigModule],