docs: fix documentation typo

Author: Romakita

docs/docs/controllers.md

@@ -471,7 +471,7 @@ With @@Returns@@ you can document correctly your endpoint to reflect the correct
 
 :::
 
-> See our codesandbox example [here](https://codesandbox.io/embed/tsed-swagger-example-ripfl?fontsize=14&hidenavigation=1&theme=dark)
+> See a live example of generics with Swagger documentation in our [interactive demo](https://codesandbox.io/embed/tsed-swagger-example-ripfl?fontsize=14&hidenavigation=1&theme=dark). This demo showcases how to implement and document generic types with proper Swagger/OpenAPI specifications.
 
 ### Throw exceptions
 

docs/docs/custom-providers.md

@@ -4,17 +4,34 @@ There are a lot of scenarios where you might want to bind something directly to
 For example, any constant values, configuration objects created based on the current environment,
 external libraries, or pre-calculated values that depend on few other defined providers.
 
-Moreover, you are able to override default implementations, e.g. use different classes or make use of various test doubles (for testing purposes) when needed.
+Moreover, you are able to override default implementations, e.g. use different classes or make use of various test
+doubles (for testing purposes) when needed.
 
 One essential thing that you should always keep in mind is that Ts.ED uses @@TokenProvider@@ to identify a dependency.
 
-Usually, the auto-generated tokens are equal to classes. If you want to create a custom provider, you'd need to choose a token.
+Usually, the auto-generated tokens are equal to classes. If you want to create a custom provider, you'd need to choose a
+token.
 Mostly, the custom tokens are represented by either plain strings or symbols.
 
 Let's go through the available options.
 
 Custom providers can also use [hooks](/docs/hooks.md) to handle Ts.ED lifecycle events.
 
+For example:
+
+```typescript
+import {Injectable} from "@tsed/di";
+
+@Injectable()
+class CustomProvider {
+  async $onInit() {
+    // Initialize your custom provider
+  }
+}
+```
+
+> There is other hooks available like `$onDestroy`, `$afterRoutesInit`, `$beforeRoutesInit`, `$onReady`, see more [here](/docs/hooks.md).
+
 ## Register Value
 
 The `useValue` syntax is useful when it comes to either define a constant value, put external library into DI container,
@@ -35,6 +52,26 @@ In order to inject custom provider, we use the @@Inject@@ decorator. This decora
 ::: warning
 When you declare a provider using a Symbol as a token, you must use the same Symbol to @@Inject@@ decorator.
 TypeScript set Object as metadata key for the Symbol token.
+
+```typescript
+// Define the symbol once and export it
+export const MY_SERVICE = Symbol.for("MY_SERVICE");
+
+// Correct usage
+@Injectable()
+class MyService {
+  @Inject(MY_SERVICE)
+  service: MyServiceType;
+}
+
+// Incorrect usage - creates a new Symbol
+@Injectable()
+class MyService {
+  @Inject()
+  service: MyServiceType;
+}
+```
+
 :::
 
 ## Register Factory
@@ -46,18 +83,14 @@ It means that factory may accept arguments, that DI will resolve and pass during
 
 <<< @/docs/snippets/providers/custom-provider-use-factory-declaration.ts
 
-In order to inject a custom provider, we use the @@Inject@@ decorator. This decorator takes a single argument - the token.
+In order to inject a custom provider, we use the @@Inject@@ decorator. This decorator takes a single argument - the
+token.
 
 ::: code-group
 <<< @/docs/snippets/providers/decorators/custom-provider-use-value-usage.ts [Decorators]
 <<< @/docs/snippets/providers/fn/custom-provider-use-value-usage.ts [Functional API]
 :::
 
-::: warning
-When you declare a provider using a Symbol as a token, you must use the same Symbol to @@Inject@@ decorator.
-TypeScript set Object as metadata key for the Symbol token.
-:::
-
 ## Register Async Factory
 
 The `useAsyncFactory` is a way of creating asynchronous providers dynamically.
@@ -70,28 +103,38 @@ It means that factory may accept arguments, that DI will resolve and pass during
 <<< @/docs/snippets/providers/v7/custom-provider-use-async-factory-declaration.ts [Legacy]
 :::
 
-In order to inject a custom provider, we use the @@Inject@@ decorator. This decorator takes a single argument - the token.
+In order to inject a custom provider, we use the @@Inject@@ decorator. This decorator takes a single argument - the
+token.
 
 ::: code-group
 <<< @/docs/snippets/providers/decorators/custom-provider-use-value-usage.ts [Decorators]
 <<< @/docs/snippets/providers/fn/custom-provider-use-value-usage.ts [Functional API]
 :::
 
-::: warning
-Because async factories are resolved on server loading, the scope of the provider created by useAsyncFactory will always be considered as `SINGLETON`.
-:::
+::: danger Important Scope Limitation
+Because async factories are resolved on server loading, the scope of the provider created by useAsyncFactory will always
+be considered as `SINGLETON`.
+
+This means:
+
+- The provider will be instantiated only once
+- The same instance will be shared across all injections
+- Request-scoped dependencies should not be used in async factories
+  :::
 
 ## Register Class
 
-The `useClass` syntax is similar to register provider via decorator. But it allows you to use different classes per chosen factors.
+The `useClass` syntax is similar to register provider via decorator. But it allows you to use different classes per
+chosen factors.
 For example, you can change the class depending on the environment profile `production` or `development`.
 
 ::: code-group
 <<< @/docs/snippets/providers/custom-provider-use-class-declaration.ts [v8]
 <<< @/docs/snippets/providers/v7/custom-provider-use-class-declaration.ts [Legacy]
 :::
 
-In this case, even if any class depends on ConfigService, Ts.ED will inject an instance of the provided class (`ProdConfigService` or `DevConfigService`) instead.
+In this case, even if any class depends on ConfigService, Ts.ED will inject an instance of the provided class (
+`ProdConfigService` or `DevConfigService`) instead.
 
 ::: code-group
 <<< @/docs/snippets/providers/decorators/custom-provider-use-class-usage.ts [Decorators]

docs/docs/providers-lazy-loading.md

@@ -18,7 +18,7 @@ speed up the bootstrap time for subsequent calls even further (deferred modules
 
 ## Usage
 
-To load a provider on-demand, Ts.ED provide decorators @@LazyInject@@ and @@OptionalLazyInject@@. Here is an example
+To load a provider on-demand, Ts.ED provides decorators @@LazyInject@@ and @@OptionalLazyInject@@. Here is an example
 with a @@PlatformExceptions@@:
 
 ::: code-group
@@ -36,7 +36,7 @@ That means, each consecutive call will be very fast and will return a cached ins
 
 :::
 
-Create you own lazy injectable doesn't require special things, just declare a module or an injectable service with default export:
+Creating your own lazy injectable does not require special configuration, just declare a module or an injectable service with default export:
 
 ::: code-group
 <<< @/docs/snippets/providers/decorators/lazy-inject-declaration.ts [Decorators]

docs/docs/providers.md

@@ -22,8 +22,9 @@ Providers are plain javascript classes and use one of these decorators on top of
 <ApiList query="['Injectable', 'Module', 'Service', 'Controller', 'Interceptor', 'Middleware', 'Protocol'].indexOf(symbolName) > -1" />
 
 ::: tip
-Since v8, you can also use functional API to define your providers using @@injectable@@ function. This function let you
-defined your provider without using decorators and let you define your provider in a more functional way.
+Since v8, you can also use the functional API to define your providers using the @@injectable@@ function. This function
+lets you
+define your provider without using decorators and lets you define your provider in a more functional way.
 
 This page will show you how to use both API to define your providers.
 
@@ -361,7 +362,7 @@ Using @@Opts@@ decorator on a constructor parameter changes the scope of the pro
 to `ProviderScope.INSTANCE`.
 :::
 
-## Inject many provider
+## Inject many providers
 
 This feature simplifies dependency management when working with multiple implementations of the same interface using
 type code.
@@ -398,7 +399,8 @@ export class SomeController {
 
 ### AutoInjectable <Badge text="7.82.0+" />
 
-The @@AutoInjectable@@ decorator let you create a class using `new` that will automatically inject all dependencies from his
+The @@AutoInjectable@@ decorator let you create a class using `new` that will automatically inject all dependencies from
+his
 constructor signature.
 
 ```ts
@@ -421,17 +423,21 @@ const myService = new MyService({
 });
 ```
 
-In this example, we can see that `MyService` is created using `new`. We can give some options to the constructor and the rest of
+In this example, we can see that `MyService` is created using `new`. We can give some options to the constructor and the
+rest of
 the dependencies will be injected automatically.
 
 ::: warning
-@@AutoInjectable@@ decorator doesn't declare the class as a provider.
+@@AutoInjectable@@ decorator only handles dependency injection when using `new`. It doesn't register the class as a
+provider in the DI container. If you need the class to be available for injection in other classes, you must still use
+@@Injectable@@.
 :::
 
 ## Interface abstraction
 
 In some cases, you may want to use an interface to abstract the implementation of a service. This is a common pattern in
-TypeScript and can be achieved by using the `provide` option in the `@Injectable` decorator or the `injectable().class()` function.
+TypeScript and can be achieved by using the `provide` option in the `@Injectable` decorator or the
+`injectable().class()` function.
 
 ::: code-group
 <<< @/docs/snippets/providers/decorators/interface-abstraction-declaration.ts [Decorators]
@@ -468,8 +474,8 @@ it may become a bottleneck for apps running in the **serverless environment**, w
 
 Lazy loading can help decrease bootstrap time by loading only modules required by the specific serverless function
 invocation.
-In addition, you could also load other modules asynchronously once the serverless function is "warm" to speed-up the
-bootstrap time for subsequent calls even further (deferred modules registration).
+Additionally, you can load other modules asynchronously once the serverless function is "warm" to speed up the
+bootstrap time for subsequent calls (deferred module registration).
 
 You can read more about these techniques [here](/docs/providers-lazy-loading.md).
 
@@ -491,10 +497,12 @@ using @@Injectable@@, @@OverrideProvider@@ decorators or @@injectable@@ function
 
 ## Inject context
 
-The @@Context@@ decorator or @@context@@ function is used to inject the request context into a class or another function.
+The @@Context@@ decorator or @@context@@ function is used to inject the request context into a class or another
+function.
 
 Context is a special object that contains all the information about the current request.
-It can be available in any injectable context, including controllers, services, and interceptors, while the request is being processed.
+It can be available in any injectable context, including controllers, services, and interceptors, while the request is
+being processed.
 
 Here is an example to get context:
 

docs/docs/snippets/providers/decorators/custom-provider-use-class-usage.ts

@@ -1,9 +1,12 @@
-import {Injectable, Inject} from "@tsed/di";
+import {Inject, Injectable} from "@tsed/di";
 import {ConfigService} from "./ConfigService.js";
 
 @Injectable()
 export class MyService {
   constructor(@Inject(ConfigService) configService: ConfigService) {
-    console.log(process.env.NODE_ENV, configService); // DevConfigService or ConfigService
+    // The injected service will be:
+    // - DevConfigService when NODE_ENV === "development"
+    // - ConfigService otherwise
+    const currentConfig = configService.get();
   }
 }

docs/docs/snippets/providers/decorators/custom-provider-use-value-usage.ts

@@ -3,6 +3,12 @@ import {CONNECTION} from "./connection.js";
 
 @Injectable()
 export class MyService {
-  constructor(@Inject(CONNECTION) connection: CONNECTION) {}
+  constructor(@Inject(CONNECTION) private connection: CONNECTION) {
+  }
+
+  async getData() {
+    // Demonstrate typical usage of the injected connection
+    return this.connection.query("SELECT * FROM example");
+  }
 }
 

docs/docs/snippets/providers/decorators/getting-started-server.ts

@@ -1,4 +1,5 @@
 import {Configuration} from "@tsed/di";
+// Note: .js extension is required when using ES modules
 import {CalendarsController} from "./controllers/CalendarsController.js";
 
 @Configuration({

docs/docs/snippets/providers/decorators/interface-abstraction-usage.ts

@@ -4,6 +4,6 @@ import {RetryPolicy} from "./RetryPolicy.js";
 @Injectable()
 export class MyService {
   constructor(@Inject(RetryPolicy) private readonly retryPolicy: RetryPolicy) {
-    // an instance of `TokenBucket`
+    // RetryPolicy will be automatically injected with its implementation (TokenBucket)
   }
 }

docs/docs/snippets/providers/decorators/lazy-inject-declaration.ts

@@ -5,7 +5,12 @@ import {Module} from "@tsed/di";
   imports: [] // Use the imports field if you have services to build
 })
 export default class MyModule {
+  private initialized: boolean = false;
   $onInit() {
-    // The hook will be called once the module is loaded
+    // This lifecycle hook is called after the module is loaded
+    // and all dependencies are resolved.
+    // Example: Initialize module-specific resources
+    this.initialized = true;
+    console.log("MyModule initialized!");
   }
 }

docs/docs/snippets/providers/decorators/scope-request.ts

@@ -4,10 +4,11 @@ import {Controller, ProviderScope, Scope} from "@tsed/di";
 @Controller("/")
 @Scope(ProviderScope.REQUEST)
 export class MyController {
+  // Generates a random number between 0 and 100 for each request
   private rand = Math.random() * 100;
 
   @Get("/random")
-  getValue() {
+  getRequestScopedRandom() {
     return this.rand;
   }
 }