doc: plugin config comments
This commit is contained in:
parent
36207f470f
commit
41dab54df3
@ -1,4 +1,4 @@
|
|||||||
import { IAppConfig } from '../types/appConfig';
|
import { IAppConfig } from '../types/pluginConfig';
|
||||||
import { engineList } from '@txtdot/plugins';
|
import { engineList } from '@txtdot/plugins';
|
||||||
import { compile } from 'html-to-text';
|
import { compile } from 'html-to-text';
|
||||||
|
|
||||||
|
@ -3,6 +3,12 @@ import { Engine } from '@txtdot/sdk';
|
|||||||
type Html2TextConverter = (html: string) => string;
|
type Html2TextConverter = (html: string) => string;
|
||||||
|
|
||||||
export interface IAppConfig {
|
export interface IAppConfig {
|
||||||
|
/**
|
||||||
|
* List of engines, ordered
|
||||||
|
*/
|
||||||
engines: Engine[];
|
engines: Engine[];
|
||||||
|
/**
|
||||||
|
* HTML to text converter, if engine doesn't support text
|
||||||
|
*/
|
||||||
html2text?: Html2TextConverter;
|
html2text?: Html2TextConverter;
|
||||||
}
|
}
|
Loading…
x
Reference in New Issue
Block a user