koatty 3.11.9 → 3.13.0

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 /*!
 * @Author: richen
-* @Date: 2025-01-14 16:20:30
+* @Date: 2025-04-19 23:06:57
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/
@@ -13,58 +13,88 @@ import { KoattyApplication } from 'koatty_core';
 import { Logger as Logger_2 } from 'koatty_logger';
 
 /**
- * @description: bind App event hook func
- * example:
+ * Bind event hook to target class.
+ *
+ * @param eventName - The application event name to bind
+ * @param eventFunc - The event hook function to be executed
+ * @param target - The target class to bind the event hook
+ * @returns {*}
+ * @throws Error if the decorated class does not inherit from Koatty.
+ * @example
+ * ```typescript
  * export function TestDecorator(): ClassDecorator {
- *  return (target: Function) => {
- *   BindEventHook(AppEvent.appBoot, (app: KoattyApplication) => {
+ *   return (target: Function) => {
+ *     BindEventHook(AppEvent.appBoot, (app: KoattyApplication) => {
  *      // todo
  *      return Promise.resolve();
  *   }, target)
  *  }
  * }
- * @param {AppEvent} eventName
- * @param {EventHookFunc} eventFunc
- * @param {any} target
- * @return {*}
  */
 export declare function BindEventHook(eventName: AppEvent, eventFunc: EventHookFunc, target: any): void;
 
 /**
- * Bootstrap application decorator
+ * Bootstrap decorator for Koatty application class.
+ *
+ * @param bootFunc Optional function to execute during bootstrap process
+ * @returns ClassDecorator
+ * @throws Error if target class does not inherit from Koatty
  *
- * @export
- * @param {Function} [bootFunc]
- * @returns {ClassDecorator}
+ * @example
+ * ```ts
+ * @Bootstrap()
+ * export class App extends Koatty {
+ *   // ...
+ * }
+ * ```
  */
 export declare function Bootstrap(bootFunc?: Function): ClassDecorator;
 
 /**
- * Define project scan path
+ * Component scan decorator for Koatty application.
+ * Scans the specified path(s) for components and registers them in the IOC container.
  *
- * @export
- * @param {(string | string[])} [scanPath]
- * @returns {ClassDecorator}
+ * @param {string | string[]} [scanPath] - The path or array of paths to scan for components
+ * @returns {ClassDecorator} A class decorator that enables component scanning
+ * @throws {Error} If the decorated class does not inherit from Koatty
+ * @example
+ * ```typescript
+ * @ComponentScan()
+ * export class App extends Koatty {
+ *   // ...
+ * }
+ * ```
  */
 export declare function ComponentScan(scanPath?: string | string[]): ClassDecorator;
 
 export { Config }
 
 /**
- * Define project configuration scan path
+ * Configuration scan decorator, used to scan and load configuration files.
  *
- * @export
- * @param {(string | string[])} [scanPath]
- * @returns {ClassDecorator}
+ * @param scanPath - The path or array of paths to scan for configuration files. If not provided, defaults to empty string.
+ * @returns A class decorator function that registers configuration scan metadata.
+ * @throws Error if the decorated class does not inherit from Koatty.
+ * @example
+ * ```typescript
+ * @ConfigurationScan()
+ * export class App extends Koatty {
+ *   // ...
+ * }
  */
 export declare function ConfigurationScan(scanPath?: string | string[]): ClassDecorator;
 
 /**
- * Actively perform dependency injection
- * Parse the decorator, return the instantiated app.
- * @export  ExecBootStrap
- * @param {Function} [bootFunc] callback function
- * @returns
+ * Decorator function for bootstrapping a Koatty application.
+ *
+ * @param bootFunc Optional function to be executed during bootstrap process
+ * @returns A decorator function that validates and executes the bootstrap process
+ * @throws Error if the target class does not inherit from Koatty
+ *
+ * @example
+ * ```typescript
+ * app = await ExecBootStrap()(App);
+ * ```
  */
 export declare function ExecBootStrap(bootFunc?: Function): (target: any) => Promise<KoattyApplication>;