Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@platohq/nestjs-clearbit

Package Overview
Dependencies
Maintainers
3
Versions
4
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@platohq/nestjs-clearbit

The NestJS module based on the official Clearbit package

  • 0.1.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
1
decreased by-66.67%
Maintainers
3
Weekly downloads
 
Created
Source

@platohq/nestjs-clearbit

The NestJS module based on the official Clearbit package

How to install

npm install @platohq/nestjs-clearbit

or

yarn add @platohq/nestjs-clearbit

How to use

Register the module

import { ClearbitModule } from '@platohq/nestjs-clearbit';

@Module({
  imports: [
    ClearbitModule.register({
      apiKey: 'YOUR_WRITE_KEY',
    }),
  ],
})
export class AppModule {}

Inject the service

import { ClearbitService } from '@platohq/nestjs-clearbit';

@Injectable()
export class AppService {
  constructor(private readonly clearbitService: ClearbitService) {}

  track() {
    this.clearbitService.track('MY_EVENT');
  }
}

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.

Use factory

ClearbitModule.registerAsync({
  useFactory: () => ({
    apiKey: 'YOUR_WRITE_KEY',
  }),
});

Use class

ClearbitModule.registerAsync({
  useClass: ClearbitConfigService,
});

Above construction will instantiate ClearbitConfigService inside ClearbitModule and will leverage it to create options object.

class ClearbitConfigService implements ClearbitOptionsFactory {
  createClearbitOptions(): ClearbitModuleOptions {
    return {
      apiKey: 'YOUR_WRITE_KEY',
    };
  }
}

Use existing

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

FAQs

Package last updated on 02 Aug 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc