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

@platohq/nestjs-analytics

Package Overview
Dependencies
Maintainers
3
Versions
5
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@platohq/nestjs-analytics

The NestJS module for Segment based on the official analytics-node package

  • 0.0.3
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
3
Created
Source

@platohq/nestjs-analytics

The NestJS module for Segment based on the official analytics-node package

How to install

npm install @platohq/nestjs-analytics

or

yarn add @platohq/nestjs-analytics

How to use

Register the module

import { AnalyticsModule } from '@platohq/nestjs-analytics';

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

Inject the service

import { AnalyticsService } from '@platohq/nestjs-analytics';

@Injectable()
export class AppService {
  constructor(private readonly analyticsService: AnalyticsService) {}

  track() {
    this.analyticsService.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

AnalyticsModule.registerAsync({
  useFactory: () => ({
    writeKey: 'YOUR_WRITE_KEY',
  }),
});

Use class

AnalyticsModule.registerAsync({
  useClass: AnalyticsConfigService,
});

Above construction will instantiate AnalyticsConfigService inside AnalyticsModule and will leverage it to create options object.

class AnalyticsConfigService implements AnalyticsOptionsFactory {
  createAnalyticsOptions(): AnalyticsModuleOptions {
    return {
      writeKey: 'YOUR_WRITE_KEY',
    };
  }
}

Use existing

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

FAQs

Package last updated on 17 Nov 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