mobx-keystone/dist/types/dataModel/getDataModelMetadata.d.ts

A MobX powered state management solution based on data trees with first class support for TypeScript, snapshots, patches and much more

import { ModelClass } from '../modelShared/BaseModelShared';
import { AnyType } from '../types/schemas';
import { AnyDataModel } from './BaseDataModel';
/**
 * Associated data model metadata.
 */
export interface DataModelMetadata {
    /**
     * Associated data type for runtime checking (if any).
     */
    dataType?: AnyType;
}
/**
 * Returns the associated metadata for a data model instance or class.
 *
 * @param modelClassOrInstance Data model class or instance.
 * @returns The associated metadata.
 */
export declare function getDataModelMetadata(modelClassOrInstance: AnyDataModel | ModelClass<AnyDataModel>): DataModelMetadata;