itlab-content-service v0.0.2

IT Lab Content Service

Diese Library funktioniert nur mit NestJs

Content module

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

Installation

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

yarn add itlab-content-service

Getting started

Once the installation process is complete, to use the ContentService, first import ContentModule.

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

Next, inject ContentService using normal constructor injection.

Hint ContentModule and ContentService are imported from itlab-content-service package.

@Injectable()
export class NewsService {
  constructor(private readonly contentService: ContentService) {}
}

Configuration

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

@Module({
  imports: [
    ContentModule.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:

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

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

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

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

ContentModule.registerAsync({
  useClass: ContentConfigService,
});

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

@Injectable()
class ContentConfigService implements ContentModuleOptionsFactory {
  createContentOptions(): ContentModuleOptions {
    return {
      token: "itlab token",
      target: "news",
    };
  }
}

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

ContentModule.registerAsync({
  imports: [ConfigModule],
  useExisting: ContentConfigService,
});