prorm API Reference
    Preparing search index...

    Interface Model

    The instance side of a model: the attribute accessors plus save, update, destroy, reload and the association helpers.

    interface Model {
        getDataValue(key: string): any;
        setDataValue(key: string, value: any): void;
        get(key: string): any;
        set(key: string, value: any): void;
        changed(key?: string): boolean | string[];
        previous(key?: string): any;
        isNewRecord: boolean;
        isDirty: boolean;
        primaryKey?: string;
        transaction?: Transaction;
        _previousDataValues: Record<string, any>;
        dataValues: Record<string, any>;
        validate(
            options?: ValidationOptions,
        ): Promise<
            | ValidationError
            | { valid: boolean; errors: ValidationErrorItem[] }
            | null,
        >;
        save(options?: SaveOptions): Promise<Model>;
        destroy(options?: DestroyOptions): Promise<void>;
        restore(options?: RestoreOptions): Promise<void>;
        reload(options?: FindOptions): Promise<Model>;
        toJSON(options?: ToJSONOptions): Record<string, any>;
    }
    Index
    isNewRecord isDirty primaryKey? transaction? _previousDataValues dataValues
    getDataValue setDataValue get set changed previous validate save destroy restore reload toJSON
    isNewRecord: boolean
    isDirty: boolean
    primaryKey?: string
    transaction?: Transaction

    _previousDataValues

    _previousDataValues: Record<string, any>
    dataValues: Record<string, any>

    • Parameters

      • key: string

      Returns any

    • Parameters

      • key: string
      • value: any

      Returns void

    • Parameters

      • key: string
      • value: any

      Returns void

    • Parameters

      • Optionalkey: string

      Returns boolean | string[]

    • Parameters

      • Optionalkey: string

      Returns any

    Settings
    Member Visibility

    On This Page
    Properties
    Methods