No description
Find a file
F.Y.N.N 5f931a951e
Some checks failed
release / release (push) Has been cancelled
Merge pull request #390 from furality/dependabot/npm_and_yarn/dependencies-2b51c50e88
build(deps-dev): bump prettier from 3.3.2 to 3.3.3 in the dependencies group
2024-07-15 07:34:14 -07:00
.github ci(action): bump actions/setup-node in the dependencies group 2024-07-09 14:51:12 +00:00
lib refactor: adjust default retries to 10 2024-03-24 00:12:44 -05:00
.editorconfig style: add editorconfig 2023-07-05 17:31:06 -05:00
.eslintignore change readme and removed unused file 2021-09-07 23:01:22 +03:00
.eslintrc.js refactor: make console an error 2024-02-10 17:32:57 -06:00
.gitignore build: stricter typescript 2023-07-05 18:33:32 -05:00
.prettierrc style: update prettierrc 2023-07-05 17:32:25 -05:00
.releaserc ci(release): add branch config 2023-07-05 17:51:11 -05:00
.spr.yml chore: add spr config 2023-12-13 15:54:52 -06:00
LICENSE working -> renamed from nestjs-http-promise-retry 2021-09-07 21:25:31 +03:00
package-lock.json build(deps-dev): bump prettier in the dependencies group 2024-07-15 14:33:41 +00:00
package.json build(deps-dev): bump prettier in the dependencies group 2024-07-15 14:33:41 +00:00
README.md docs: update README 2024-04-18 20:54:19 -05:00
tsconfig.json refactor(ts): make consistent with other packages 2023-12-29 20:29:53 -06:00

nestjs-http-promise

npm version npm downloads

description

nestjs module that just doing little modification to the original and good nestjs http module.

features

  • axios - the most used package for http requests in npm and the one used by nestjs official http library.
  • promise based - most of us using the current http module that uses observable which we don't use most of the time and in order to avoid it were just calling .toPromise() every http call.
  • retries - in many cases we will want to retry a failing http call. with observable we could just add the retry operator (rxjs) but with promises we need to implement this logic ourselves. this package will make it easy for you, just pass { retries: NUMBER_OF_RETRIES } in the config of the http module. more details in the configuration section

quick start

installing

Using npm:

$ npm install nestjs-http-promise

Using yarn:

$ yarn add nestjs-http-promise

usage - just like every nest.js module

import the module:

import { HttpModule } from 'nestjs-http-promise'

@Module({
  imports: [HttpModule]
})

inject the service in the class:

import { HttpService } from 'nestjs-http-promise'

class Demo {
    constructor(private readonly httpService: HttpService) {}
}

use the service:

public callSomeServer(): Promise<object> {
  return this.httpService.get('http://fakeService')
}

configuration

the service uses axios and axios-retry, so you can pass any AxiosRequestConfig And/Or AxiosRetryConfig

just pass it in the .register() method as you would do in the original nestjs httpModule

import { HttpModule } from 'nestjs-http-promise'

@Module({
  imports: [HttpModule.register(
    {
      timeout: 1000,
      retries: 10,
        ...
    }
  )]
})

default configuration

async configuration

When you need to pass module options asynchronously instead of statically, use the registerAsync() method just like in nest httpModule.

you have a couple of techniques to do it:

  • with the useFactory
HttpModule.registerAsync({
    useFactory: () => ({
    timeout: 1000,
    retries: 10,
      ...
    }),
});
  • using class
HttpModule.registerAsync({
  useClass: HttpConfigService,
});

Note that in this example, the HttpConfigService has to implement HttpModuleOptionsFactory interface as shown below.

@Injectable()
class HttpConfigService implements HttpModuleOptionsFactory {
  async createHttpOptions(): Promise<HttpModuleOptions> {
    const configurationData = await someAsyncMethod();
    return {
      timeout: configurationData.timeout,
      retries: 10,
        ...
    };
  }
}

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

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