@mvx/model/src/metadata/FieldMetadata.d.ts

@mvx/model is model for mvc frameworker on server.

import { PropertyMetadata, Type } from '@tsdi/ioc';
/**
 * Field metadata.
 *
 * @export
 * @interface FieldMetadata
 * @extends {PropertyMetadata}
 */
export interface FieldMetadata extends PropertyMetadata {
    /**
     * name of Filed decorator entends Decorator type.
     *
     * @type {string}
     * @memberof FieldMetadata
     */
    decorName?: string;
    /**
     * Filed ref model type.
     *
     * @type {string}
     * @memberof FieldMetadata
     */
    refType?: Type;
    /**
     * db type.
     *
     * @type {string}
     * @memberof FieldMetadata
     */
    dbtype?: string;
    /**
     * db filed name. default use field name.
     *
     * @type {string}
     * @memberof FieldMetadata
     */
    dbfield?: string;
    /**
     * field can required or not.
     *
     * @type {boolean}
     * @memberof FieldMetadata
     */
    required?: boolean;
    /**
     * column db default value.
     *
     * @type {*}
     * @memberof FieldMetadata
     */
    defaultValue?: any;
}