import type { AwilixContainer } from './container'; import type { GlobWithOptions, ModuleDescriptor, listModules } from './list-modules'; import type { BuildResolverOptions } from './resolvers'; /** * Metadata of the module as well as the loaded module itself. * @interface LoadedModuleDescriptor */ export interface LoadedModuleDescriptor extends ModuleDescriptor { value: unknown; } /** * The options when invoking loadModules(). * @interface LoadModulesOptions */ export interface LoadModulesOptions { cwd?: string; formatName?: NameFormatter | BuiltInNameFormatters; resolverOptions?: BuildResolverOptions; esModules?: ESM; } /** * Name formatting options when using loadModules(). * @type BuiltInNameFormatters */ export type BuiltInNameFormatters = 'camelCase'; /** * Takes in the filename of the module being loaded as well as the module descriptor, * and returns a string which is used to register the module in the container. * * `descriptor.name` is the same as `name`. * * @type {NameFormatter} */ export type NameFormatter = (name: string, descriptor: LoadedModuleDescriptor) => string; /** * Dependencies for `loadModules` */ export interface LoadModulesDeps { listModules: typeof listModules; container: AwilixContainer; require(path: string): any | Promise; } /** * The list of loaded modules */ export interface LoadModulesResult { loadedModules: Array; } export declare function loadModules(dependencies: LoadModulesDeps, globPatterns: string | Array, opts?: LoadModulesOptions): ESM extends true ? Promise : LoadModulesResult;