@adpt/cli/dist/src/config/config.d.ts

AdaptJS command line interface

import { IConfig } from "@oclif/config";
import Conf from "conf";
import { VersionSummaryEntry } from "../upgrade/versions";
import { SchemaInputType, SchemaOutputType } from "./schema";
/**
 * Schema for user config.
 */
export declare const userConfigSchema: {
    upgradeCheck: {
        description: string;
        default: boolean;
        asType: "boolean";
    };
    upgradeChannel: {
        description: string;
        default: string;
        asType: "string";
    };
    upgradeCheckInterval: {
        description: string;
        default: string;
        asType: "duration";
    };
    upgradeCheckUrl: {
        description: string;
        default: string;
        asType: "string";
    };
    upgradeRemindInterval: {
        description: string;
        default: string;
        asType: "duration";
    };
    upgradeIgnore: {
        description: string;
        default: string;
        asType: "string";
    };
};
export declare type UserConfigSchema = typeof userConfigSchema;
/**
 * Union type of the valid configuration properties.
 */
export declare type UserConfigProps = keyof UserConfigSchema;
/**
 * Array of the valid configuration properties (keys).
 */
export declare const userConfigProps: ("upgradeCheck" | "upgradeChannel" | "upgradeCheckInterval" | "upgradeCheckUrl" | "upgradeRemindInterval" | "upgradeIgnore")[];
/**
 * Defines what is accepted as input types for the user config.
 */
export declare type UserConfig = SchemaInputType<UserConfigSchema>;
/**
 * Defines the final user config types, after parsing and any
 * transformation. This is the primary type used for accessing user
 * config data.
 */
export declare type UserConfigParsed = SchemaOutputType<UserConfigSchema>;
/**
 * Non-user-facing CLI state. This is distinct from any Adapt deployment
 * state and is automatically and atomically read/saved on **every**
 * read or write operation. Managed by Conf.
 */
export interface CliState {
    installed: number;
    lastUpgradeCheck: number;
    lastUpgradeReminder?: number;
    upgrade?: {
        latest: string;
        summary?: VersionSummaryEntry;
    };
    version: string;
}
export declare const cliStateDefaults: {
    installed: number;
    lastUpgradeCheck: number;
    version: any;
};
export interface CliConfig {
    user: UserConfigParsed;
    userConfigFile: string;
    package: IConfig;
    state: Conf<CliState>;
}
export declare function lookupConfigProperty(name: string): "upgradeCheck" | "upgradeChannel" | "upgradeCheckInterval" | "upgradeCheckUrl" | "upgradeRemindInterval" | "upgradeIgnore" | undefined;
export declare function parseConfigItemString<P extends UserConfigProps>(prop: P, val: string): {
    parsed: string | number | boolean;
    store: {};
};
//# sourceMappingURL=config.d.ts.map