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

@jporter-dev/nestjs-opensearch

v1.2.2

Published

Nest - modern, fast, powerful node.js web framework (@opensearch-project/opensearch)

Downloads

385

Readme

Description

Opensearch module for Nest based on the official @opensearch-project/opensearch package.

Installation

$ npm i --save @jporter-dev/nestjs-opensearch @opensearch-project/opensearch

Usage

Import OpensearchModule:

@Module({
  imports: [OpensearchModule.register({
    node: 'http://localhost:9200',
  })],
  providers: [...],
})
export class SearchModule {}

Inject OpensearchService:

@Injectable()
export class SearchService {
  constructor(private readonly opensearchService: OpensearchService) {}
}

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

OpensearchModule.registerAsync({
  useFactory: () => ({
    node: 'http://localhost:9200'
  })
});

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

OpensearchModule.registerAsync({
  imports: [ConfigModule],
  useFactory: async (configService: ConfigService) => ({
    node: configService.get('OPENSEARCH_NODE'),
  }),
  inject: [ConfigService],
}),

2. Use class

OpensearchModule.registerAsync({
  useClass: OpensearchConfigService
});

Above construction will instantiate OpensearchConfigService inside OpensearchModule and will leverage it to create options object.

class OpensearchConfigService implements OpensearchOptionsFactory {
  createOpensearchOptions(): OpensearchModuleOptions {
    return {
      node: 'http://localhost:9200'
    };
  }
}

3. Use existing

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

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

API Spec

The OpensearchService wraps the Client from the official @opensearch-project/opensearch methods. The OpensearchModule.register() takes options object as an argument, read more.

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

License

Nest is MIT licensed.