winterspec/dist/config/config.d.ts

Write Winter-CG compatible routes with filesystem routing and tons of features

import { z } from "zod";
declare const winterSpecConfigSchema: z.ZodObject<{
    /**
     * Defaults to the current working directory.
     */
    rootDirectory: z.ZodOptional<z.ZodString>;
    /**
     * If this path is relative, it's resolved relative to the `rootDirectory` option.
     */
    tsconfigPath: z.ZodOptional<z.ZodString>;
    /**
     * If this path is relative, it's resolved relative to the `rootDirectory` option.
     */
    routesDirectory: z.ZodOptional<z.ZodString>;
    /**
     * The platform you're targeting.
     *
     * Defaults to `wintercg-minimal`, and you should use this whenever possible for maximal compatibility.
     *
     * Check [the docs](https://github.com/tscircuit/winterspec/blob/main/docs/winterspec-config.md) for more information.
     */
    platform: z.ZodOptional<z.ZodDefault<z.ZodEnum<["node", "wintercg-minimal"]>>>;
}, "strict", z.ZodTypeAny, {
    rootDirectory?: string | undefined;
    tsconfigPath?: string | undefined;
    routesDirectory?: string | undefined;
    platform?: "node" | "wintercg-minimal" | undefined;
}, {
    rootDirectory?: string | undefined;
    tsconfigPath?: string | undefined;
    routesDirectory?: string | undefined;
    platform?: "node" | "wintercg-minimal" | undefined;
}>;
export type WinterSpecConfig = z.infer<typeof winterSpecConfigSchema>;
export declare const defineConfig: (config: WinterSpecConfig) => WinterSpecConfig;
export {};