solid-register/dist/read-config.d.ts

integrated package to run solid browser code in node

export declare type SolidRegisterConfiguration = {
    compile?: {
        /** configure solid configuration */
        solid?: boolean | {
            engine: "solid";
            extensions?: string[];
        } | {
            engine: "ts-node";
        } | {
            engine: "babel";
            extensions: string[];
        };
        /** configure css (modules) compilation */
        css?: boolean | {
            /** support loading CSS (default is `['.css']`) */
            extensions?: string[];
            /** support CSS modules (string array allows to select extensions) */
            modules?: boolean | string[];
            /** support postCSS (string array allows to select extensions, needs to be installed in project) */
            postcss?: boolean | string[];
        };
        assets?: {
            /** an array with the extensions string of the files that should return an asset path, i.e. `['.svg', '.csv']` */
            extensions: string[];
        } | boolean;
    };
    /** which DOM implementation should be registered and what URL should be used (default: whatever is found first, jsdom, happy-dom or linkedom and https://localhost:3000) */
    dom?: "jsdom" | "happy-dom" | "linkedom" | {
        engine: "jsdom" | "happy-dom" | "linkedom";
        url?: string;
    } | false;
    /** setup filename aliasing for running browser/dev/server versions of solid or mocks */
    aliases?: {
        /**
         * an object containing find-Expressions that will be used as `RegExp` and the value as a replace string,
         * @example ```ts
         * "filenames": { "my-dependency": "my-dependency/mock" }
         * ```
         * You can also use replace groups and other `RegExp` features
         */
        filenames?: {
            [find: string]: string;
        };
        /**
         * The extensions for which files the aliases for import/require statements should be applied, including the dot; default is `['.js', '.jsx', '.ts', '.tsx']`
         */
        extensions?: string[];
        /**
         * A shorthand to mock the resolution of solid environments, default is `'dev'`
         *
         * You can alternatively run your testing with `node --conditions browser [testing script]`; in this case, the solid aliases will not be applied
         */
        solid?: "server" | "dev" | "browser";
    };
    /** files you want to run to setup your environment */
    setupFiles?: string[];
};
declare const config: SolidRegisterConfiguration;
declare const projectPath: any;
export { projectPath };
export declare const conditions: string[];
export declare const usesConditions: boolean;
export { config };