import { EntityMetadata } from '@mikro-orm/core'; import { SchemableObject } from 'kobp'; export interface SchemaDocInfo { /** * Use this attribute to explicitly define the type of the property */ schema?: SchemableObject; /** * useful when leave the schema empty */ isArray?: boolean; /** * provide the immediate field's description */ description?: string; /** * marking field as Readonly */ readonly?: boolean; } /** * Using augmentApiDoc for update all Entities so that they are `kobp/SchemableObject` * * @usage ```ts * const ormConfig = defineConfig({ * // the configs * discovery: { * onMetadata: augmentApiDoc, * }, * }) * ``` */ export declare const augmentApiDoc: (metadata: EntityMetadata) => void; /** * Annotate property with API Doc info and it schema */ export declare const ApiDoc: (docInfo: SchemaDocInfo) => PropertyDecorator;