@douglasneuroinformatics/libnest
    Preparing search index...

    Type Alias UserConfigOptions

    Configuration options for a libnest application.

    type UserConfigOptions = {
        build: {
            bundle?: boolean;
            mode?: "module" | "server";
            nativeDependencies?: (KnownNativeDependencyName | NativeDependency)[];
            onComplete?: () => Promisable<void>;
            outfile: string;
        };
        entry: () => Promise<{ [key: string]: any }>;
        globals?: { [key: string]: Jsonifiable };
    }
    Index

    Properties

    build entry globals?

    Properties

    build: {
        bundle?: boolean;
        mode?: "module" | "server";
        nativeDependencies?: (KnownNativeDependencyName | NativeDependency)[];
        onComplete?: () => Promisable<void>;
        outfile: string;
    }

    Configuration options for the production build

    Type Declaration

    • Optionalbundle?: boolean
    • Optionalmode?: "module" | "server"
    • OptionalnativeDependencies?: (KnownNativeDependencyName | NativeDependency)[]

      Dependencies that cannot survive bundling, because they load a native artifact through a path relative to their own source. Each is emitted next to the bundle and redirected there at startup. Naming one the application never imports fails the build.

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

      A callback function to invoke when the build is complete

    • outfile: string

      The path where the bundle should be written

    entry

    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.

    globals?: { [key: string]: Jsonifiable }

    Optional global variables that should be defined at runtime.

    Settings

    Member Visibility

    On This Page

    Properties