49 lines
1.0 KiB
TypeScript
49 lines
1.0 KiB
TypeScript
/**
|
|
Encode summary to provide an API to plugin
|
|
|
|
@param {Output} output
|
|
@param {Config} config
|
|
@return {Object}
|
|
*/
|
|
declare function encodeSummary(output: any, summary: any): {
|
|
/**
|
|
Iterate over the summary, it stops when the "iter" returns false
|
|
|
|
@param {Function} iter
|
|
*/
|
|
walk: (iter: any) => void;
|
|
/**
|
|
Get an article by its level
|
|
|
|
@param {string} level
|
|
@return {Object}
|
|
*/
|
|
getArticleByLevel: (level: any) => {
|
|
title: string;
|
|
level: string;
|
|
depth: number;
|
|
anchor: string;
|
|
url: string;
|
|
path: string;
|
|
ref: string;
|
|
articles: any;
|
|
};
|
|
/**
|
|
Get an article by its path
|
|
|
|
@param {string} level
|
|
@return {Object}
|
|
*/
|
|
getArticleByPath: (level: any) => {
|
|
title: string;
|
|
level: string;
|
|
depth: number;
|
|
anchor: string;
|
|
url: string;
|
|
path: string;
|
|
ref: string;
|
|
articles: any;
|
|
};
|
|
};
|
|
export default encodeSummary;
|
|
//# sourceMappingURL=encodeSummary.d.ts.map
|