ts-json-schema-generator
Version:
Generate JSON schema from your Typescript sources
23 lines (22 loc) • 754 B
TypeScript
export interface Config {
path?: string;
type?: string;
minify?: boolean;
schemaId?: string;
tsconfig?: string;
expose?: "all" | "none" | "export";
topRef?: boolean;
jsDoc?: "none" | "extended" | "basic";
markdownDescription?: boolean;
sortProps?: boolean;
strictTuples?: boolean;
skipTypeCheck?: boolean;
encodeRefs?: boolean;
extraTags?: string[];
additionalProperties?: boolean;
discriminatorType?: "json-schema" | "open-api";
functions?: FunctionOptions;
}
export type CompletedConfig = Config & typeof DEFAULT_CONFIG;
export type FunctionOptions = "fail" | "comment" | "hide";
export declare const DEFAULT_CONFIG: Omit<Required<Config>, "path" | "type" | "schemaId" | "tsconfig">;