Refactor: change the module configuration method name [register] to [forRoot]

felanios / murlock

MurLock: A distributed locking solution for NestJS, providing a decorator for critical sections with Redis-based synchronization. Ideal for microservices and scalable applications.

https://www.npmjs.com/package/murlock

MIT License

62 stars 1 forks source link

Refactor: change the module configuration method name [register] to [forRoot] #22

Closed OsoianMarcel closed 8 months ago

OsoianMarcel commented 8 months ago

According to NestJS Community guidelines, the global modules should be configured with the method forRoot / forRootAsync.

register - expecting to configure a dynamic module with a specific configuration for use only by the calling module.
forRoot - you are expecting to configure a dynamic module once and reuse that configuration in multiple places.

It would be nice to follow NestJS community guidelines.

felanios commented 8 months ago

Hi @OsoianMarcel, thanks for feedback. This week I'll publish a new version.

felanios commented 8 months ago

Hi @OsoianMarcel, I published the beta version for this changes. You can check this 3.0.0-beta.1

felanios commented 8 months ago

Hi @OsoianMarcel, I published the stable version 3.0.0