a2r/utils/devSettings.d.ts

A2R Framework

import { DevSettings, RunningProjectInfo } from '../model';
/**
 * Checks if dev settings exist
 */
export declare const settingsExist: (projectPath?: string | undefined) => Promise<boolean>;
/**
 * Gets dev settings
 * @param projectPath Main project path
 */
export declare const getSettings: (projectPath?: string | undefined) => Promise<DevSettings>;
/**
 * Writes given info as dev settings
 * @param info Info to save
 * @param projectPath Main project path
 */
export declare const saveSettings: (info: DevSettings, projectPath?: string | undefined) => Promise<DevSettings>;
/**
 * Inits dev settings
 * @param serverPort Port that server will be using
 * @param projectPath Main project path
 */
export declare const init: (serverPort: number, serverDockerName: string, serverDockerImage: string, keys?: [string, string][] | undefined, projectPath?: string | undefined) => Promise<DevSettings>;
/**
 * Update several key-value pairs
 * @param keys Key-Value pairs
 */
export declare const setKeys: (keys: [string, string][]) => Promise<void>;
/**
 * Set key value
 * @param key Key name
 * @param value Key value
 */
export declare const setKey: (key: string, value: string) => Promise<void>;
/**
 * Gets keys dictionary
 */
export declare const getKeys: () => Promise<{
    [key: string]: string;
}>;
/**
 * Gets key value
 * @param key Key name
 */
export declare const getKey: (key: string) => Promise<string | undefined>;
/**
 * Adds project to active project
 * @param project Project info
 */
export declare const addActiveProject: (project: RunningProjectInfo) => Promise<void>;