boats
Version:
Beautiful Open / Async Template System - Write less yaml with BOATS and Nunjucks.
15 lines (14 loc) • 907 B
TypeScript
import { AutoChannelIndexerOptions, AutoComponentIndexerOptions, GetIndexYamlOptions } from './interfaces/GetIndexYamlOptions';
import { BoatsRC } from './interfaces/BoatsRc';
declare class AutoIndexer {
getFiles(dir: string): any[];
cleanFilePaths(dir: string, filePaths: string[], indexFile: string): string[];
createChannelString(boatsrc: BoatsRC, cleanPath: string, autoChannelIndexerOptions?: AutoChannelIndexerOptions): string;
buildPathsYamlString(cleanPaths: string[], boatsrc: BoatsRC, channels?: any, components?: any, paths?: any, autoComponentIndexerOptions?: AutoComponentIndexerOptions, autoChannelIndexerOptions?: AutoChannelIndexerOptions): string;
/**
* Returns a string from an auto-built yaml file
*/
getIndexYaml(indexFile: string, boatsrc: BoatsRC, options: GetIndexYamlOptions): string;
}
declare const _default: AutoIndexer;
export default _default;