vue-styleguidist
Version:
Vue components style guide generator
14 lines (13 loc) • 649 B
TypeScript
import { StyleguidistConfig, SanitizedStyleguidistConfig } from '../types/StyleGuide';
/**
* Read, parse and validate config file or passed config.
*
* @param {object|string} [config] All config options or config file name or nothing.
* @param {function} [update] Change config object before running validation on it.
* @returns {object}
*/
export default function getConfig(configParam: string | StyleguidistConfig | {
serverPort?: string | number;
}, update?: (conf: SanitizedStyleguidistConfig | {
serverPort?: string | number;
}) => SanitizedStyleguidistConfig): Promise<SanitizedStyleguidistConfig> | SanitizedStyleguidistConfig;