smartscaf/dist/smartscaf.classes.smartscaf.d.ts

36 lines
977 B
TypeScript
Raw Normal View History

2017-04-28 22:44:23 +00:00
import { Smartfile } from 'smartfile';
export interface ScafTemplateContructorOptions {
name?: string;
description?: string;
sourceDir?: string;
}
export declare class ScafTemplate {
name: string;
description: string;
2017-05-03 07:45:22 +00:00
templateSmartfileArray: Smartfile[];
requiredVariables: string[];
suppliedVariables: any;
missingVariables: string[];
2017-04-28 22:44:23 +00:00
/**
* read a template from a directory
*/
2017-05-03 07:45:22 +00:00
readTemplateFromDir(dirPathArg: string): Promise<void>;
/**
* supply the variables to render the teplate with
* @param variablesArg
*/
supplyVariables(variablesArg: any): Promise<void>;
2017-05-06 23:23:03 +00:00
/**
* Will ask for the missing variables by cli interaction
*/
askCliForMissingVariables(): Promise<void>;
2017-04-28 22:44:23 +00:00
/**
* finds all variables in a Template
*/
private _findVariablesInTemplate();
/**
* checks if supplied Variables satisfy the template
*/
2017-05-06 23:23:03 +00:00
private _checkSuppliedVariables();
2017-04-28 22:44:23 +00:00
}