@palmares/events/dist/src/domain.d.ts

This is the events framework for palmares, it's responsible for handling everything that is Pub/Sub like websockets, pub/sub like redis, and other types of asynchronous background tasks

import type { EventHandlerType } from './interfaces';
export declare const eventsDomainModifier: {
    new (): {
        load: (settings: unknown) => void | Promise<void> | ((args: import("@palmares/core").DomainReadyFunctionArgs<unknown, any>) => void | Promise<void>) | Promise<(args: import("@palmares/core").DomainReadyFunctionArgs<unknown, any>) => void | Promise<void>>;
        ready: (args: import("@palmares/core").DomainReadyFunctionArgs<unknown, any>) => void | Promise<void>;
        close: (() => void | Promise<void>) | undefined;
        commands: import("@palmares/core").DefaultCommandType | undefined;
        instances?: import("@palmares/core").Domain<any>[];
        name: string;
        path: string;
        isLoaded: boolean;
        modifiers: {
            getEvents: () => Promise<{
                [eventName: string]: EventHandlerType | {
                    handler: EventHandlerType;
                    withResult: boolean;
                };
            }>;
        };
        __isReady: boolean;
        __isClosed: boolean;
    };
    toJSON: () => {
        name: string;
        path: string;
    };
    $$type: string;
    __instance: import("@palmares/core").Domain<any>;
} & (new () => {
    load: (settings: unknown) => void | Promise<void> | ((args: import("@palmares/core").DomainReadyFunctionArgs<unknown, any>) => void | Promise<void>) | Promise<(args: import("@palmares/core").DomainReadyFunctionArgs<unknown, any>) => void | Promise<void>>;
    ready: (args: import("@palmares/core").DomainReadyFunctionArgs<unknown, any>) => void | Promise<void>;
    close: (() => void | Promise<void>) | undefined;
    commands: import("@palmares/core").DefaultCommandType | undefined;
    instances?: import("@palmares/core").Domain<any>[];
    name: string;
    path: string;
    isLoaded: boolean;
    modifiers: {
        getEvents: () => Promise<{
            [eventName: string]: EventHandlerType | {
                handler: EventHandlerType;
                withResult: boolean;
            };
        }>;
    };
    __isReady: boolean;
    __isClosed: boolean;
});
export declare const eventsDomain: {
    new (): {
        load: (settings: unknown) => void | Promise<void> | ((args: import("@palmares/core").DomainReadyFunctionArgs<unknown, any>) => void | Promise<void>) | Promise<(args: import("@palmares/core").DomainReadyFunctionArgs<unknown, any>) => void | Promise<void>>;
        ready: (args: import("@palmares/core").DomainReadyFunctionArgs<unknown, any>) => void | Promise<void>;
        close: (() => void | Promise<void>) | undefined;
        commands: {
            readonly eventsServer: {
                readonly description: "Run the application in events server mode";
                readonly positionalArgs: undefined;
                readonly keywordArgs: undefined;
                readonly handler: () => {
                    new (domains: import("@palmares/core").Domain[], settings: import("@palmares/core").SettingsType2): {
                        start: (configureCleanup: (args?: any) => Promise<void> | void) => Promise<void>;
                        load: ({ settings, domains }: {
                            domains: import("@palmares/core").Domain[];
                            commandLineArgs: import("@palmares/core").DomainHandlerFunctionArgs["commandLineArgs"];
                            settings: import("@palmares/core").SettingsType2;
                        }) => Promise<void>;
                        close: () => Promise<void>;
                        baseAppServer: import("@palmares/core/dist/src/app").BaseAppServer;
                    };
                    $$type: string;
                };
            };
        } | undefined;
        instances?: import("@palmares/core").Domain<any>[];
        name: string;
        path: string;
        isLoaded: boolean;
        modifiers: unknown;
        __isReady: boolean;
        __isClosed: boolean;
    };
    toJSON: () => {
        name: string;
        path: string;
    };
    $$type: string;
    __instance: import("@palmares/core").Domain<any>;
} & (new () => {
    load: (settings: unknown) => void | Promise<void> | ((args: import("@palmares/core").DomainReadyFunctionArgs<unknown, any>) => void | Promise<void>) | Promise<(args: import("@palmares/core").DomainReadyFunctionArgs<unknown, any>) => void | Promise<void>>;
    ready: (args: import("@palmares/core").DomainReadyFunctionArgs<unknown, any>) => void | Promise<void>;
    close: (() => void | Promise<void>) | undefined;
    commands: {
        readonly eventsServer: {
            readonly description: "Run the application in events server mode";
            readonly positionalArgs: undefined;
            readonly keywordArgs: undefined;
            readonly handler: () => {
                new (domains: import("@palmares/core").Domain[], settings: import("@palmares/core").SettingsType2): {
                    start: (configureCleanup: (args?: any) => Promise<void> | void) => Promise<void>;
                    load: ({ settings, domains }: {
                        domains: import("@palmares/core").Domain[];
                        commandLineArgs: import("@palmares/core").DomainHandlerFunctionArgs["commandLineArgs"];
                        settings: import("@palmares/core").SettingsType2;
                    }) => Promise<void>;
                    close: () => Promise<void>;
                    baseAppServer: import("@palmares/core/dist/src/app").BaseAppServer;
                };
                $$type: string;
            };
        };
    } | undefined;
    instances?: import("@palmares/core").Domain<any>[];
    name: string;
    path: string;
    isLoaded: boolean;
    modifiers: unknown;
    __isReady: boolean;
    __isClosed: boolean;
} & {
    commands: {
        readonly eventsServer: {
            readonly description: "Run the application in events server mode";
            readonly positionalArgs: undefined;
            readonly keywordArgs: undefined;
            readonly handler: () => {
                new (domains: import("@palmares/core").Domain[], settings: import("@palmares/core").SettingsType2): {
                    start: (configureCleanup: (args?: any) => Promise<void> | void) => Promise<void>;
                    load: ({ settings, domains }: {
                        domains: import("@palmares/core").Domain[];
                        commandLineArgs: import("@palmares/core").DomainHandlerFunctionArgs["commandLineArgs"];
                        settings: import("@palmares/core").SettingsType2;
                    }) => Promise<void>;
                    close: () => Promise<void>;
                    baseAppServer: import("@palmares/core/dist/src/app").BaseAppServer;
                };
                $$type: string;
            };
        };
    };
});
//# sourceMappingURL=domain.d.ts.map