convict-doc/dist/renderer.d.ts

converts a Convict schema into rendered documentation. At this Moment it will be rendered as a markdown table.

import * as Convict from "convict";
export declare function renderField(fieldName: keyof Convict.SchemaObj<unknown> | 'name', name: string, obj: Convict.SchemaObj<unknown>): string;
export declare function renderDoc<T = any>(schema: Convict.Schema<T>, order?: string[]): string;
export declare function renderSchemaObj(name: string, obj: Convict.SchemaObj<unknown>, order?: string[]): string;
export declare function renderSchema<T>(schema: Convict.Schema<T>, namePrefix?: string, order?: string[], render?: string): string;
export declare function renderNullable(obj: Convict.SchemaObj<unknown>): string;
export declare function renderSensitive(obj: Convict.SchemaObj<unknown>): string;
export declare function renderFormat(obj: Convict.SchemaObj<unknown>): string;