Type Alias UserConfigOptions

UserConfigOptions: {
    build: {
        esbuildOptions?: Pick<BuildOptions, "footer">;
        mode?: "module" | "server";
        onComplete?: () => Promisable<void>;
        outfile: string;
    };
    entry: () => Promise<{ [key: string]: any }>;
    globals?: { [key: string]: Jsonifiable };
}

Configuration options for a libnest application.

Type declaration

  • build: {
        esbuildOptions?: Pick<BuildOptions, "footer">;
        mode?: "module" | "server";
        onComplete?: () => Promisable<void>;
        outfile: string;
    }

    Configuration options for the production build

    • OptionalesbuildOptions?: Pick<BuildOptions, "footer">

      Additional options to pass to esbuild

    • Optionalmode?: "module" | "server"

      The type of bundle to generate. If set to module, the bundle will be a module with the AppContainer as the default export. If set to standalone, running the bundle will launch the production server.

      Default

      'server'
    • OptionalonComplete?: () => Promisable<void>

      A callback function to invoke when the build is complete

    • outfile: string

      The path where the bundle should be written

  • entry: () => Promise<{ [key: string]: any }>

    The entry point for the libnest CLI.

    This should be a module whose default export is a function that initializes the application.

  • Optionalglobals?: { [key: string]: Jsonifiable }

    Optional global variables that should be defined at runtime.

Settings

Member Visibility