@atls/nestjs-dataloader 0.0.4 → 0.0.6

package/README.md

@@ -0,0 +1,59 @@
+# Установка
+
+```bash
+yarn add @atls/nestjs-dataloader
+```
+
+# Использование
+
+1. Импортируйте DataLoaderModule в ваш модуль:
+
+```typescript
+import { DataLoaderModule } from '@atls/nestjs-dataloader'
+
+@Module({
+  imports: [DataLoaderModule],
+})
+export class AppModule {}
+```
+
+2. Создайте свой кастомный DataLoader:
+
+```typescript
+import * as DataLoader from 'dataloader'
+import { Injectable }  from '@nestjs/common'
+@Injectable()
+export class MyDataLoader extends DataLoader<string, string> {
+  constructor() {
+    super(async (keys: string[]) => {
+      / Ваш код для загрузки данных пачками
+    })
+  }
+}
+```
+
+3. Зарегистрируйте ваш DataLoader в провайдерах:
+
+```typescript
+import { MyDataLoader } from './my-dataloader'
+
+@Module({
+  providers: [MyDataLoader],
+})
+export class AppModule {}
+```
+
+4. Инжектируйте DataLoader в резолверы и сервисы:
+
+```typescript
+import { MyDataLoader } from './my-dataloader'
+
+@Injectable()
+export class MyService {
+  constructor(private readonly dataLoader: MyDataLoader) {}
+
+  async getData(key: string) {
+    return this.dataLoader.load(key)
+  }
+}
+```

package/dist/constants.d.ts

@@ -0,0 +1 @@
+export declare const GET_LOADER_CONTEXT_KEY: string;

package/dist/decorators/index.d.ts

@@ -0,0 +1,2 @@
+export * from './order-result-by-key.decorator';
+export * from './loader.decorator';

package/dist/decorators/loader.decorator.d.ts

@@ -0,0 +1 @@
+export declare const Loader: (type: string) => ParameterDecorator;

package/dist/decorators/order-result-by-key.decorator.d.ts

@@ -0,0 +1 @@
+export declare const OrderResultByKey: (key?: string, defaultValue?: undefined) => (target: any, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './interceptors';
+export * from './decorators';
+export * from './interfaces';

package/dist/interceptors/data-loader.interceptor.d.ts

@@ -0,0 +1,10 @@
+import { CallHandler } from '@nestjs/common';
+import { ExecutionContext } from '@nestjs/common';
+import { NestInterceptor } from '@nestjs/common';
+import { ModuleRef } from '@nestjs/core';
+import { Observable } from 'rxjs';
+export declare class DataLoaderInterceptor implements NestInterceptor {
+    private readonly moduleRef;
+    constructor(moduleRef: ModuleRef);
+    intercept(context: ExecutionContext, next: CallHandler): Observable<any>;
+}

package/dist/interceptors/index.d.ts

@@ -0,0 +1 @@
+export * from './data-loader.interceptor';

package/dist/interfaces/index.d.ts

@@ -0,0 +1 @@
+export * from './nest-dataloader.interfaces';

package/dist/interfaces/nest-dataloader.interfaces.d.ts

@@ -0,0 +1,4 @@
+import DataLoader from 'dataloader';
+export interface NestDataLoader {
+    generateDataLoader(): DataLoader<any, any>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atls/nestjs-dataloader",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "license": "BSD-3-Clause",
   "main": "dist/index.js",
   "files": [