@eggjs/core 7.0.0-beta.20 → 7.0.0-beta.22

package/dist/base_context_class.d.ts

@@ -0,0 +1,16 @@
+import type { EggCore, Context } from './egg.ts';
+/**
+ * BaseContextClass is a base class that can be extended,
+ * it's instantiated in context level,
+ * {@link Helper}, {@link Service} is extending it.
+ */
+export declare class BaseContextClass {
+    ctx: Context;
+    app: EggCore;
+    config: Record<string, any>;
+    service: BaseContextClass;
+    /**
+     * @since 1.0.0
+     */
+    constructor(ctx: Context);
+}

package/dist/base_context_class.js

@@ -0,0 +1,37 @@
+/**
+ * BaseContextClass is a base class that can be extended,
+ * it's instantiated in context level,
+ * {@link Helper}, {@link Service} is extending it.
+ */
+export class BaseContextClass {
+    ctx;
+    app;
+    config;
+    service;
+    /**
+     * @since 1.0.0
+     */
+    constructor(ctx) {
+        /**
+         * @member {Context} BaseContextClass#ctx
+         * @since 1.0.0
+         */
+        this.ctx = ctx;
+        /**
+         * @member {Application} BaseContextClass#app
+         * @since 1.0.0
+         */
+        this.app = ctx.app;
+        /**
+         * @member {Config} BaseContextClass#config
+         * @since 1.0.0
+         */
+        this.config = ctx.app.config;
+        /**
+         * @member {Service} BaseContextClass#service
+         * @since 1.0.0
+         */
+        this.service = ctx.service;
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYmFzZV9jb250ZXh0X2NsYXNzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2Jhc2VfY29udGV4dF9jbGFzcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFFQTs7OztHQUlHO0FBQ0gsTUFBTSxPQUFPLGdCQUFnQjtJQUMzQixHQUFHLENBQVU7SUFDYixHQUFHLENBQVU7SUFDYixNQUFNLENBQXNCO0lBQzVCLE9BQU8sQ0FBbUI7SUFFMUI7O09BRUc7SUFDSCxZQUFZLEdBQVk7UUFDdEI7OztXQUdHO1FBQ0gsSUFBSSxDQUFDLEdBQUcsR0FBRyxHQUFHLENBQUM7UUFDZjs7O1dBR0c7UUFDSCxJQUFJLENBQUMsR0FBRyxHQUFHLEdBQUcsQ0FBQyxHQUFHLENBQUM7UUFDbkI7OztXQUdHO1FBQ0gsSUFBSSxDQUFDLE1BQU0sR0FBRyxHQUFHLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQztRQUM3Qjs7O1dBR0c7UUFDSCxJQUFJLENBQUMsT0FBTyxHQUFHLEdBQUcsQ0FBQyxPQUFPLENBQUM7SUFDN0IsQ0FBQztDQUNGIn0=

package/dist/egg.d.ts

@@ -0,0 +1,246 @@
+import { Application as KoaApplication, Context as KoaContext, Request as KoaRequest, Response as KoaResponse, type MiddlewareFunc as KoaMiddlewareFunc, type Next } from '@eggjs/koa';
+import { EggConsoleLogger, type Logger } from 'egg-logger';
+import { EggRouter as Router, type RegisterOptions, type ResourcesController } from '@eggjs/router';
+import type { ReadyFunctionArg } from 'get-ready';
+import { BaseContextClass } from './base_context_class.ts';
+import { Timing } from './utils/timing.ts';
+import { Lifecycle } from './lifecycle.ts';
+import { EggLoader } from './loader/egg_loader.ts';
+import { type Fun } from './utils/index.ts';
+import type { EggAppConfig } from './types.ts';
+import { type SingletonCreateMethod } from './singleton.ts';
+export declare const EGG_LOADER: unique symbol;
+export interface EggCoreOptions {
+    baseDir: string;
+    type: 'application' | 'agent';
+    plugins?: any;
+    serverScope?: string;
+    env?: string;
+}
+export type EggCoreInitOptions = Partial<EggCoreOptions>;
+export { KoaRequest, KoaResponse, KoaContext, KoaApplication, Router };
+export type { Next, KoaMiddlewareFunc };
+export declare class Request extends KoaRequest {
+    app: EggCore;
+    response: Response;
+}
+export declare class Response extends KoaResponse {
+    app: EggCore;
+    request: Request;
+}
+export declare class Context extends KoaContext {
+    app: EggCore;
+    request: Request;
+    response: Response;
+    service: BaseContextClass;
+    /**
+     * Returns map of URL parameters for given `path` and `paramNames`.
+     * @example
+     * ##### ctx.params.id {string}
+     *
+     * `GET /api/users/1` => `'1'`
+     *
+     * ##### ctx.params.per_page {string}
+     *
+     * The number of every page, `GET /api/users?per_page=20` => `20`
+     */
+    params?: Record<string, string>;
+    /**
+     * Returns array of router regexp url path captures.
+     */
+    captures?: string[];
+    /**
+     * Returns the name of the matched router.
+     */
+    routerName?: string;
+    /**
+     * Returns the path of the matched router.
+     */
+    routerPath?: string | RegExp;
+}
+export type MiddlewareFunc<T extends KoaContext = Context> = KoaMiddlewareFunc<T>;
+export declare class EggCore extends KoaApplication {
+    #private;
+    options: EggCoreOptions;
+    timing: Timing;
+    console: EggConsoleLogger;
+    BaseContextClass: typeof BaseContextClass;
+    Controller: typeof BaseContextClass;
+    Service: typeof BaseContextClass;
+    Helper?: typeof BaseContextClass;
+    lifecycle: Lifecycle;
+    loader: EggLoader;
+    /** auto inject on loadService() */
+    readonly serviceClasses: Record<string, any>;
+    /** auto inject on loadController() */
+    readonly controller: Record<string, any>;
+    /** auto inject on loadMiddleware() */
+    readonly middlewares: Record<string, (opt: unknown, app: EggCore) => MiddlewareFunc>;
+    /**
+     * @class
+     * @param {Object} options - options
+     * @param {String} [options.baseDir] - the directory of application
+     * @param {String} [options.type] - whether it's running in app worker or agent worker
+     * @param {Object} [options.plugins] - custom plugins
+     * @since 1.0.0
+     */
+    constructor(options?: EggCoreInitOptions);
+    get logger(): Logger;
+    get coreLogger(): Logger;
+    /**
+     * create a singleton instance
+     * @param {String} name - unique name for singleton
+     * @param {Function|AsyncFunction} create - method will be invoked when singleton instance create
+     */
+    addSingleton(name: string, create: SingletonCreateMethod): void;
+    /**
+     * override koa's app.use, support generator function
+     * @since 1.0.0
+     */
+    use<T extends KoaContext = Context>(fn: MiddlewareFunc<T>): this;
+    /**
+     * Whether `application` or `agent`
+     * @member {String}
+     * @since 1.0.0
+     */
+    get type(): "application" | "agent";
+    /**
+     * The current directory of application
+     * @member {String}
+     * @see {@link AppInfo#baseDir}
+     * @since 1.0.0
+     */
+    get baseDir(): string;
+    /**
+     * Alias to {@link https://npmjs.com/package/depd}
+     * @member {Function}
+     * @since 1.0.0
+     */
+    get deprecate(): (message: string) => void;
+    /**
+     * The name of application
+     * @member {String}
+     * @see {@link AppInfo#name}
+     * @since 1.0.0
+     */
+    get name(): any;
+    /**
+     * Retrieve enabled plugins
+     * @member {Object}
+     * @since 1.0.0
+     */
+    get plugins(): Record<string, import("./types.ts").EggPluginInfo>;
+    /**
+     * The configuration of application
+     * @member {Config}
+     * @since 1.0.0
+     */
+    get config(): EggAppConfig;
+    /**
+     * Execute scope after loaded and before app start.
+     *
+     * Notice:
+     * This method is now NOT recommended and regarded as a deprecated one,
+     * For plugin development, we should use `didLoad` instead.
+     * For application development, we should use `willReady` instead.
+     *
+     * @see https://eggjs.org/en/advanced/loader.html#beforestart
+     *
+     * @param  {Function} scope function will execute before app start
+     * @param {string} [name] scope name, default is empty string
+     */
+    beforeStart(scope: Fun, name?: string): void;
+    /**
+     * register an callback function that will be invoked when application is ready.
+     * @see https://github.com/node-modules/get-ready
+     * @since 1.0.0
+     * @example
+     * const app = new Application(...);
+     * app.ready(err => {
+     *   if (err) throw err;
+     *   console.log('done');
+     * });
+     */
+    ready(): Promise<void>;
+    ready(flagOrFunction: ReadyFunctionArg): void;
+    /**
+     * If a client starts asynchronously, you can register `readyCallback`,
+     * then the application will wait for the callback to ready
+     *
+     * It will log when the callback is not invoked after 10s
+     *
+     * Recommend to use {@link EggCore#beforeStart}
+     * @since 1.0.0
+     *
+     * @param {String} name - readyCallback task name
+     * @param {object} opts -
+     *   - {Number} [timeout=10000] - emit `ready_timeout` when it doesn't finish but reach the timeout
+     *   - {Boolean} [isWeakDep=false] - whether it's a weak dependency
+     * @returns {Function} - a callback
+     * @example
+     * const done = app.readyCallback('mysql');
+     * mysql.ready(done);
+     */
+    readyCallback(name: string, opts: object): (...args: unknown[]) => void;
+    /**
+     * Register a function that will be called when app close.
+     *
+     * Notice:
+     * This method is now NOT recommended directly used,
+     * Developers SHOULDN'T use app.beforeClose directly now,
+     * but in the form of class to implement beforeClose instead.
+     *
+     * @see https://eggjs.org/en/advanced/loader.html#beforeclose
+     *
+     * @param {Function} fn - the function that can be generator function or async function.
+     */
+    beforeClose(fn: Fun, name?: string): void;
+    /**
+     * Close all, it will close
+     * - callbacks registered by beforeClose
+     * - emit `close` event
+     * - remove add listeners
+     *
+     * If error is thrown when it's closing, the promise will reject.
+     * It will also reject after following call.
+     * @returns {Promise} promise
+     * @since 1.0.0
+     */
+    close(): Promise<void>;
+    /**
+     * get router
+     * @member {Router} EggCore#router
+     * @since 1.0.0
+     */
+    get router(): Router;
+    /**
+     * Alias to {@link Router#url}
+     * @param {String} name - Router name
+     * @param {Object} params - more parameters
+     * @returns {String} url
+     */
+    url(name: string, params?: Parameters<Router['url']>[1]): string;
+    head(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
+    head(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
+    get(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
+    get(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
+    put(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
+    put(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
+    patch(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
+    patch(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
+    post(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
+    post(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
+    delete(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
+    delete(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
+    del(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
+    del(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
+    all(path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
+    all(name: string, path: string | RegExp | (string | RegExp)[], ...middlewares: (MiddlewareFunc | string)[]): EggCore;
+    resources(prefix: string, controller: string | ResourcesController): EggCore;
+    resources(prefix: string, middleware: MiddlewareFunc, controller: string | ResourcesController): EggCore;
+    resources(name: string, prefix: string, controller: string | ResourcesController): EggCore;
+    resources(name: string, prefix: string, middleware: MiddlewareFunc, controller: string | ResourcesController): EggCore;
+    redirect(source: string, destination: string, status?: number): this;
+    register(path: string | RegExp | (string | RegExp)[], methods: string[], middleware: MiddlewareFunc | MiddlewareFunc[], opts?: RegisterOptions): this;
+    get [EGG_LOADER](): typeof EggLoader;
+}