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

@fugle/marketdata-nest

v1.1.0

Published

A Nest module wrapper for @fugle/marketdata

Downloads

30

Readme

@fugle/marketdata-nest

NPM version

A Nest module wrapper for @fugle/marketdata

Installation

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

$ npm install --save @fugle/marketdata-nest @fugle/marketdata

Getting started

Once the installation is complete, to use the RestClient or WebSocketClient, first import FugleMarketDataModule and pass the options with apiKey to the forRoot() method.

import { Module } from '@nestjs/common';
import { FugleMarketDataModule } from '@fugle/marketdata-nest';

@Module({
  imports: [
    FugleMarketDataModule.forRoot({
      apiKey: 'YOUR_API_KEY',
    }),
  ],
})
export class AppModule {}

Next, inject the RestClient instance using the @InjectRestClient() decorator.

constructor(@InjectRestClient() private readonly client: RestClient) {}

The @InjectWebSocketClient() decorator is used for the WebSocketClient instance injection.

constructor(@InjectWebSocketClient() private readonly client: WebSocketClient) {}

Async configuration

When you need to pass module options asynchronously instead of statically, use the forRootAsync() method. As with most dynamic modules, Nest provides several techniques to deal with async configuration.

One technique is to use a factory function:

FugleMarketDataModule.forRootAsync({
  useFactory: () => ({
    apiKey: 'YOUR_API_KEY',
  }),
});

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

FugleMarketDataModule.forRootAsync({
  imports: [ConfigModule],
  useFactory: async (configService: ConfigService) => ({
    apiKey: configService.get('FUGLE_MARKETDATA_API_KEY'),
  }),
  inject: [ConfigService],
});

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

FugleMarketDataModule.forRootAsync({
  useClass: FugleMarketDataConfigService,
});

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

@Injectable()
class FugleMarketDataConfigService implements FugleMarketDataModuleOptionsFactory {
  createFugleMarketDataOptions(): FugleMarketDataModuleOptions {
    return {
      apiKey: 'YOUR_API_KEY',
    };
  }
}

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

FugleMarketDataModule.forRootAsync({
  imports: [ConfigModule],
  useExisting: FugleMarketDataConfigService,
});

Reference

License

MIT