@tanstack/cli/dist/types/cli.d.ts

TanStack CLI

import type { CliOptions } from './types.js';
import type { FrameworkDefinition, Options } from '@tanstack/create';
export declare function getCreateTelemetryProperties(projectName: string, options: CliOptions): {
    add_on_count: number | undefined;
    add_on_ids: string[] | undefined;
    addon_details_id: string | undefined;
    command_variant: string;
    deployment: string | undefined;
    bundler: string | undefined;
    examples: boolean | undefined;
    blank: boolean;
    framework: string | undefined;
    git: boolean | undefined;
    install: boolean;
    intent: boolean;
    interactive: boolean;
    json: boolean;
    non_interactive: boolean;
    package_manager: "npm" | "yarn" | "pnpm" | "bun" | "deno" | undefined;
    project_name_provided: boolean;
    router_only: boolean;
    target_dir_flag: boolean;
    toolchain: string | undefined;
    yes: boolean;
    starter_kind?: undefined;
    starter_id?: undefined;
} | {
    add_on_count: number | undefined;
    add_on_ids: string[] | undefined;
    addon_details_id: string | undefined;
    command_variant: string;
    deployment: string | undefined;
    bundler: string | undefined;
    examples: boolean | undefined;
    blank: boolean;
    framework: string | undefined;
    git: boolean | undefined;
    install: boolean;
    intent: boolean;
    interactive: boolean;
    json: boolean;
    non_interactive: boolean;
    package_manager: "npm" | "yarn" | "pnpm" | "bun" | "deno" | undefined;
    project_name_provided: boolean;
    router_only: boolean;
    target_dir_flag: boolean;
    toolchain: string | undefined;
    yes: boolean;
    starter_kind: string;
    starter_id?: undefined;
} | {
    add_on_count: number | undefined;
    add_on_ids: string[] | undefined;
    addon_details_id: string | undefined;
    command_variant: string;
    deployment: string | undefined;
    bundler: string | undefined;
    examples: boolean | undefined;
    blank: boolean;
    framework: string | undefined;
    git: boolean | undefined;
    install: boolean;
    intent: boolean;
    interactive: boolean;
    json: boolean;
    non_interactive: boolean;
    package_manager: "npm" | "yarn" | "pnpm" | "bun" | "deno" | undefined;
    project_name_provided: boolean;
    router_only: boolean;
    target_dir_flag: boolean;
    toolchain: string | undefined;
    yes: boolean;
    starter_id: string | undefined;
    starter_kind: string;
};
export declare function getResolvedCreateTelemetryProperties(finalOptions: Options, cliOptions: CliOptions): {
    add_on_count: number;
    add_on_ids: string[];
    deployment: string | undefined;
    bundler: string | undefined;
    examples: boolean;
    blank: boolean;
    framework: string | undefined;
    git: boolean;
    install: boolean;
    intent: boolean;
    package_manager: "npm" | "yarn" | "pnpm" | "bun" | "deno";
    router_only: boolean;
    toolchain: string | undefined;
    starter_kind?: undefined;
    starter_id?: undefined;
} | {
    add_on_count: number;
    add_on_ids: string[];
    deployment: string | undefined;
    bundler: string | undefined;
    examples: boolean;
    blank: boolean;
    framework: string | undefined;
    git: boolean;
    install: boolean;
    intent: boolean;
    package_manager: "npm" | "yarn" | "pnpm" | "bun" | "deno";
    router_only: boolean;
    toolchain: string | undefined;
    starter_kind: string;
    starter_id?: undefined;
} | {
    add_on_count: number;
    add_on_ids: string[];
    deployment: string | undefined;
    bundler: string | undefined;
    examples: boolean;
    blank: boolean;
    framework: string | undefined;
    git: boolean;
    install: boolean;
    intent: boolean;
    package_manager: "npm" | "yarn" | "pnpm" | "bun" | "deno";
    router_only: boolean;
    toolchain: string | undefined;
    starter_id: string | undefined;
    starter_kind: string;
};
export declare function cli({ name, appName, forcedAddOns, forcedDeployment, defaultFramework, frameworkDefinitionInitializers, showDeploymentOptions, legacyAutoCreate, defaultRouterOnly, }: {
    name: string;
    appName: string;
    forcedAddOns?: Array<string>;
    forcedDeployment?: string;
    defaultFramework?: string;
    frameworkDefinitionInitializers?: Array<() => FrameworkDefinition>;
    showDeploymentOptions?: boolean;
    legacyAutoCreate?: boolean;
    defaultRouterOnly?: boolean;
}): void;