itlab-comment-service v0.0.3

IT Lab Comment Service

Diese Library funktioniert nur mit NestJs

Comment module

Axios is richly featured HTTP client package that is widely used. This package wraps Axios and exposes it via the built-in CommentModule. The CommentModule exports the CommentService class, which exposes methods to perform HTTP requests to the IT Lab Comment Service.

Installation

To begin using it, we first install the required dependency.

yarn add itlab-comment-service

Getting started

Once the installation process is complete, to use the CommentService, first import CommentModule.

@Module({
  imports: [CommentModule],
  providers: [NewsService],
})
export class NewsModule {}

Next, inject CommentService using normal constructor injection.

Hint CommentModule and CommentService are imported from itlab-comment-service package.

@Injectable()
export class NewsService {
  constructor(private readonly commentService: CommentService) {}
}

Methods

async verifyComment(comments: unknown[]): Promise<void>

async postComment(targetId: string, comments: unknown[]): Promise<void>

async deleteComment(targetId: string): Promise<void>

Configuration

To configure the underlying service instance, pass an optional options object to the register() method of CommentModule when importing it. This options object will be passed directly to the underlying service constructor.

@Module({
  imports: [
    CommentModule.register({
      token: "itlab token",
      target: "news",
    }),
  ],
  providers: [NewsService],
})
export class NewsModule {}

Async configuration

When you need to pass module options asynchronously instead of statically, use the registerAsync() method. As with most dynamic modules, this package provides several techniques to deal with async configuration.

One technique is to use a factory function:

CommentModule.registerAsync({
  useFactory: () => ({
    token: "itlab token",
    target: "news",
  }),
});

Like other factory providers, our factory function can be async and can inject dependencies through inject.

CommentModule.registerAsync({
  imports: [ConfigModule],
  useFactory: (configService: ConfigService) => ({
    token: configService.get<string>('K8S_TOKEN'),
    target: "news",
  }),
  inject: [ConfigService],
});

Alternatively, you can configure the CommentModule using a class instead of a factory, as shown below.

CommentModule.registerAsync({
  useClass: CommentConfigService,
});

The construction above instantiates CommentConfigService inside CommentModule, using it to create an options object. Note that in this example, the CommentConfigService has to implement CommentModuleOptionsFactory interface as shown below. The CommentModule will call the createCommentOptions() method on the instantiated object of the supplied class.

@Injectable()
class CommentConfigService implements CommentModuleOptionsFactory {
  createCommentOptions(): CommentModuleOptions {
    return {
      token: "itlab token",
      target: "news",
    };
  }
}

If you want to reuse an existing options provider instead of creating a private copy inside the CommentModule, use the useExisting syntax.

CommentModule.registerAsync({
  imports: [ConfigModule],
  useExisting: CommentConfigService,
});