Class ModelMetaData

Storage for model metadata

Public

Index

Constructors

Methods

getFieldJsonDescriptor getFieldJsonDescriptors getFieldMainDescriptor getFieldMainDescriptors getHasManyJsonDescriptor getHasManyJsonDescriptors getHasManyMainDescriptor getHasManyMainDescriptors getHasOneJsonDescriptor getHasOneJsonDescriptors getHasOneMainDescriptor getHasOneMainDescriptors getPrimaryKeyFieldDescriptors setFieldMainDescriptor setHasManyMainDescriptor setHasOneMainDescriptor

Constructors

constructor

new ModelMetaData(): ModelMetaData
Returns ModelMetaData

Methods

`Static`getFieldJsonDescriptor

getFieldJsonDescriptor<T extends AbstractModel<any>>(
target: ClassCtor<T>,
propertyName: ModelFieldKey<T, any>,
): undefined | ClassPropertyDescriptor<T, AbstractField<any, BaseOptions>>
Returns the JSON descriptor of the model field. One descriptor corresponds to one field. The Json descriptor may not be specified, in which case null is returned
Type Parameters
- T extends AbstractModel<any>
Parameters
- target: ClassCtor<T>
- propertyName: ModelFieldKey<T, any>
Returns undefined | ClassPropertyDescriptor<T, AbstractField<any, BaseOptions>>
- Defined in app-sdk/index.d.ts:10692

`Static`getFieldJsonDescriptors

getFieldJsonDescriptors<T extends AbstractModel<any>>(
target: ClassCtor<T>,
): ClassPropertyDescriptor<T, AbstractField<any, BaseOptions>>[]
Returns a json field descriptors in the model. One descriptor corresponds to one field.
Type Parameters
- T extends AbstractModel<any>
Parameters
- target: ClassCtor<T>
Returns ClassPropertyDescriptor<T, AbstractField<any, BaseOptions>>[]
- Defined in app-sdk/index.d.ts:10687

`Static`getFieldMainDescriptor

getFieldMainDescriptor<T extends AbstractModel<any>>(
target: ClassCtor<T>,
propertyName: ModelFieldKey<T, any>,
): ClassPropertyDescriptor<T, AbstractField<any, BaseOptions>>
Returns the main descriptor of the model field. One descriptor corresponds to one field.
Type Parameters
- T extends AbstractModel<any>
Parameters
- target: ClassCtor<T>
- propertyName: ModelFieldKey<T, any>
Returns ClassPropertyDescriptor<T, AbstractField<any, BaseOptions>>
- Defined in app-sdk/index.d.ts:10683

`Static`getFieldMainDescriptors

getFieldMainDescriptors<T extends AbstractModel<any>>(
target: ClassCtor<T>,
): ClassPropertyDescriptor<T, AbstractField<any, BaseOptions>>[]
Returns an array of the main descriptors of the model fields. One descriptor corresponds to one field.
Type Parameters
- T extends AbstractModel<any>
Parameters
- target: ClassCtor<T>
Returns ClassPropertyDescriptor<T, AbstractField<any, BaseOptions>>[]
- Defined in app-sdk/index.d.ts:10679

`Static`getHasManyJsonDescriptor

getHasManyJsonDescriptor<T extends AbstractModel<any>>(
target: ClassCtor<T>,
propertyName: ModelFieldCollectionKey<T, any>,
): undefined | ClassPropertyDescriptor<T, ModelCollection<any>>
Returns the JSON descriptor of the hasMany model. One descriptor corresponds to one field. The Json descriptor may not be specified, in which case null is returned
Type Parameters
- T extends AbstractModel<any>
Parameters
- target: ClassCtor<T>
- propertyName: ModelFieldCollectionKey<T, any>
Returns undefined | ClassPropertyDescriptor<T, ModelCollection<any>>
- Defined in app-sdk/index.d.ts:10734

`Static`getHasManyJsonDescriptors

getHasManyJsonDescriptors<T extends AbstractModel<any>>(
target: ClassCtor<T>,
): ClassPropertyDescriptor<T, ModelCollection<any>>[]
Returns json handles for the has Many model. One descriptor corresponds to one field.
Type Parameters
- T extends AbstractModel<any>
Parameters
- target: ClassCtor<T>
Returns ClassPropertyDescriptor<T, ModelCollection<any>>[]
- Defined in app-sdk/index.d.ts:10729

`Static`getHasManyMainDescriptor

getHasManyMainDescriptor<T extends AbstractModel<any>>(
target: ClassCtor<T>,
propertyName: ModelFieldCollectionKey<T, any>,
): ClassPropertyDescriptor<T, ModelCollection<any>>
Returns the main descriptor of the hasMany model. One descriptor corresponds to one field.
Type Parameters
- T extends AbstractModel<any>
Parameters
- target: ClassCtor<T>
- propertyName: ModelFieldCollectionKey<T, any>
Returns ClassPropertyDescriptor<T, ModelCollection<any>>
- Defined in app-sdk/index.d.ts:10725

`Static`getHasManyMainDescriptors

getHasManyMainDescriptors<T extends AbstractModel<any>>(
target: ClassCtor<T>,
): ClassPropertyDescriptor<T, ModelCollection<any>>[]
Returns an array of the main hasMany model descriptors. One descriptor corresponds to one field.
Type Parameters
- T extends AbstractModel<any>
Parameters
- target: ClassCtor<T>
Returns ClassPropertyDescriptor<T, ModelCollection<any>>[]
- Defined in app-sdk/index.d.ts:10721

`Static`getHasOneJsonDescriptor

getHasOneJsonDescriptor<T extends AbstractModel<any>>(
target: ClassCtor<T>,
propertyName: ModelFieldModelKey<T, any>,
): undefined | ClassPropertyDescriptor<T, AbstractModel<any>>
Returns the model's has One json descriptor. One descriptor corresponds to one field. The Json descriptor may not be specified, in which case null is returned
Type Parameters
- T extends AbstractModel<any>
Parameters
- target: ClassCtor<T>
- propertyName: ModelFieldModelKey<T, any>
Returns undefined | ClassPropertyDescriptor<T, AbstractModel<any>>
- Defined in app-sdk/index.d.ts:10713

`Static`getHasOneJsonDescriptors

getHasOneJsonDescriptors<T extends AbstractModel<any>>(
target: ClassCtor<T>,
): ClassPropertyDescriptor<T, any>[]
Returns JSON handles for the has One model. One descriptor corresponds to one field.
Type Parameters
- T extends AbstractModel<any>
Parameters
- target: ClassCtor<T>
Returns ClassPropertyDescriptor<T, any>[]
- Defined in app-sdk/index.d.ts:10708

`Static`getHasOneMainDescriptor

getHasOneMainDescriptor<T extends AbstractModel<any>>(
target: ClassCtor<T>,
propertyName: ModelFieldModelKey<T, any>,
): ClassPropertyDescriptor<T, AbstractModel<any>>
Returns the main hasone descriptor of the model. One descriptor corresponds to one field.
Type Parameters
- T extends AbstractModel<any>
Parameters
- target: ClassCtor<T>
- propertyName: ModelFieldModelKey<T, any>
Returns ClassPropertyDescriptor<T, AbstractModel<any>>
- Defined in app-sdk/index.d.ts:10704

`Static`getHasOneMainDescriptors

getHasOneMainDescriptors<T extends AbstractModel<any>>(
target: ClassCtor<T>,
): ClassPropertyDescriptor<T, AbstractModel<any>>[]
Returns an array of the main hasone descriptors of the model. One descriptor corresponds to one field.
Type Parameters
- T extends AbstractModel<any>
Parameters
- target: ClassCtor<T>
Returns ClassPropertyDescriptor<T, AbstractModel<any>>[]
- Defined in app-sdk/index.d.ts:10700

`Static`getPrimaryKeyFieldDescriptors

getPrimaryKeyFieldDescriptors<T extends AbstractModel<any>>(
target: ClassCtor<T>,
): ClassPropertyDescriptor<T, AbstractField<any, BaseOptions>>[]
Returns field descriptors that are the primary key Currently, only one primary key field is allowed. But at the stage of model validation, there may be several of them.
Type Parameters
- T extends AbstractModel<any>
Parameters
- target: ClassCtor<T>
Returns ClassPropertyDescriptor<T, AbstractField<any, BaseOptions>>[]
- Defined in app-sdk/index.d.ts:10671

`Static`setFieldMainDescriptor

setFieldMainDescriptor<
    F extends AbstractField<any, BaseOptions>,
    C extends BaseOptions,
>(
    ctor: ClassCtor<F>,
    config: C,
): FieldDecorator<F>
Records the basis of the descriptor field of the model
Type Parameters
- F extends AbstractField<any, BaseOptions>
- C extends BaseOptions
Parameters
- ctor: ClassCtor<F>
- config: C
Returns FieldDecorator<F>
- Defined in app-sdk/index.d.ts:10675

`Static`setHasManyMainDescriptor

setHasManyMainDescriptor<F extends ModelCollection<any>, C extends BaseOptions>(
ctor: ClassCtor<F>,
config: C,
): FieldDecorator<F>
Writes the base hasMany model descriptor
Type Parameters
- F extends ModelCollection<any>
- C extends BaseOptions
Parameters
- ctor: ClassCtor<F>
- config: C
Returns FieldDecorator<F>
- Defined in app-sdk/index.d.ts:10717

`Static`setHasOneMainDescriptor

setHasOneMainDescriptor<
    F extends AbstractModel<any>,
    C extends IHasOneMainDescriptorConfig<F, void>,
>(
    config: C,
): FieldDecorator<F>
Writes the base hasone model descriptor
Type Parameters
- F extends AbstractModel<any>
- C extends IHasOneMainDescriptorConfig<F, void>
Parameters
- config: C
Returns FieldDecorator<F>
- Defined in app-sdk/index.d.ts:10696

Class ModelMetaData

Public

Index

Constructors

Methods

Constructors

constructor

Returns ModelMetaData

Methods

StaticgetFieldJsonDescriptor

Type Parameters

Parameters

Returns undefined | ClassPropertyDescriptor<T, AbstractField<any, BaseOptions>>

StaticgetFieldJsonDescriptors

Type Parameters

Parameters

Returns ClassPropertyDescriptor<T, AbstractField<any, BaseOptions>>[]

StaticgetFieldMainDescriptor

Type Parameters

Parameters

Returns ClassPropertyDescriptor<T, AbstractField<any, BaseOptions>>

StaticgetFieldMainDescriptors

Type Parameters

Parameters

Returns ClassPropertyDescriptor<T, AbstractField<any, BaseOptions>>[]

StaticgetHasManyJsonDescriptor

Type Parameters

Parameters

Returns undefined | ClassPropertyDescriptor<T, ModelCollection<any>>

StaticgetHasManyJsonDescriptors

Type Parameters

Parameters

Returns ClassPropertyDescriptor<T, ModelCollection<any>>[]

StaticgetHasManyMainDescriptor

Type Parameters

Parameters

Returns ClassPropertyDescriptor<T, ModelCollection<any>>

StaticgetHasManyMainDescriptors

Type Parameters

Parameters

Returns ClassPropertyDescriptor<T, ModelCollection<any>>[]

StaticgetHasOneJsonDescriptor

Type Parameters

Parameters

Returns undefined | ClassPropertyDescriptor<T, AbstractModel<any>>

StaticgetHasOneJsonDescriptors

Type Parameters

Parameters

Returns ClassPropertyDescriptor<T, any>[]

StaticgetHasOneMainDescriptor

Type Parameters

Parameters

Returns ClassPropertyDescriptor<T, AbstractModel<any>>

StaticgetHasOneMainDescriptors

Type Parameters

Parameters

Returns ClassPropertyDescriptor<T, AbstractModel<any>>[]

StaticgetPrimaryKeyFieldDescriptors

Type Parameters

Parameters

Returns ClassPropertyDescriptor<T, AbstractField<any, BaseOptions>>[]

StaticsetFieldMainDescriptor

Type Parameters

Parameters

Returns FieldDecorator<F>

StaticsetHasManyMainDescriptor

Type Parameters

Parameters

Returns FieldDecorator<F>

StaticsetHasOneMainDescriptor

Type Parameters

Parameters

Returns FieldDecorator<F>

On This Page

`Static`getFieldJsonDescriptor

`Static`getFieldJsonDescriptors

`Static`getFieldMainDescriptor

`Static`getFieldMainDescriptors

`Static`getHasManyJsonDescriptor

`Static`getHasManyJsonDescriptors

`Static`getHasManyMainDescriptor

`Static`getHasManyMainDescriptors

`Static`getHasOneJsonDescriptor

`Static`getHasOneJsonDescriptors

`Static`getHasOneMainDescriptor

`Static`getHasOneMainDescriptors

`Static`getPrimaryKeyFieldDescriptors

`Static`setFieldMainDescriptor

`Static`setHasManyMainDescriptor

`Static`setHasOneMainDescriptor