prorm API Reference
    Preparing search index...

    Variable CommentRegistryConst

    CommentRegistry: {
        getTableComment: (target: Function) => string | undefined;
        getFieldComment: (
            target: Function,
            fieldName: string,
        ) => string | undefined;
        getAllFieldComments: (target: Function) => Record<string, string>;
        setIndexComment: (
            target: Function,
            indexName: string,
            comment: string,
        ) => void;
        getIndexComment: (
            target: Function,
            indexName: string,
        ) => string | undefined;
        getAllIndexComments: (target: Function) => Record<string, string>;
        setConstraintComment: (
            target: Function,
            constraintName: string,
            comment: string,
        ) => void;
        getConstraintComment: (
            target: Function,
            constraintName: string,
        ) => string | undefined;
        getAllConstraintComments: (target: Function) => Record<string, string>;
        clearComments(target: Function): void;
    } = ...

    Type Declaration

    • getTableComment: (target: Function) => string | undefined
    • getFieldComment: (target: Function, fieldName: string) => string | undefined
    • getAllFieldComments: (target: Function) => Record<string, string>
    • setIndexComment: (target: Function, indexName: string, comment: string) => void
    • getIndexComment: (target: Function, indexName: string) => string | undefined
    • getAllIndexComments: (target: Function) => Record<string, string>
    • setConstraintComment: (target: Function, constraintName: string, comment: string) => void
    • getConstraintComment: (target: Function, constraintName: string) => string | undefined
    • getAllConstraintComments: (target: Function) => Record<string, string>
    • clearComments: function