nest-groq

Description

Groq module for Nest based on the official groq-sdk package.

Installation

$ npm i --save @bytebitlabs/nest-groq groq-sdk

Usage

Import GroqModule:

@Module({
  imports: [GroqModule.register({
    apiKey: 'Abc...',
  })],
  providers: [...],
})
export class AiModule {}

Inject GroqService:

@Injectable()
export class AiService {
  constructor(private readonly groqService: GroqService) {}
}

Async options

Quite often you might want to asynchronously pass your module options instead of passing them beforehand. In such case, use registerAsync() method, that provides a couple of various ways to deal with async data.

1. Use factory

GroqModule.registerAsync({
  useFactory: () => ({
    apiKey: 'Abc...'
  })
});

Obviously, our factory behaves like every other one (might be async and is able to inject dependencies through inject).

GroqModule.registerAsync({
  imports: [ConfigModule],
  useFactory: async (configService: ConfigService) => ({
    apiKey: configService.get('GROQ_API_KEY'),
  }),
  inject: [ConfigService],
}),

2. Use class

GroqModule.registerAsync({
  useClass: GroqConfigService
});

Above construction will instantiate GroqConfigService inside GroqModule and will leverage it to create options object.

class GroqConfigService implements GroqOptionsFactory {
  createGroqOptions(): GroqModuleOptions {
    return {
      apiKey: 'Abc...'
    };
  }
}

3. Use existing

GroqModule.registerAsync({
  imports: [ConfigModule],
  useExisting: ConfigService,
}),

It works the same as useClass with one critical difference - GroqModule will lookup imported modules to reuse already created ConfigService, instead of instantiating it on its own.

API Spec

The GroqService wraps the Client from the official groq-sdk methods. The GroqModule.register() takes options object as an argument, read more.