export interface Directive { name: string; module: string; description: string; syntax: string[]; contexts: string[]; isBlock: boolean; default: string; } export interface Variable { name: string; module: string; description: string; } export declare enum Format { Markdown = 1, HTML = 2 } /** * Returns all the nginx directives * * @param: format: format of the return type HTML or markdown * @return: an array of Directives */ export declare function getDirectives(format?: Format): Directive[]; /** * Returns all variables defined by any moduled * * @param: format: format of the return type HTML or markdown * @return: an array of Variables */ export declare function getVariables(format?: Format): Variable[]; /** * Returns the description corresponding to the directive or variable name * * @param: directive: directive name to find * @param: module: optional name of module * @param: format: format of the return type HTML or markdown * * @return: a string containing the description of the directive in xml or markdown format */ export declare function find(directive: string, module: string | undefined, format?: Format): string | undefined;