npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

itlab-comment-service

v0.0.3

Published

> Diese Library funktioniert nur mit NestJs

Downloads

4

Readme

IT Lab Comment Service

Diese Library funktioniert nur mit NestJs

npm version install size npm downloads jsdelivr

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,
});