Model | metaphasejs

Hierarchy

Base
- Model

Indexable

[otherProps: string]: any

Index

Constructors

constructor

Properties

model

Methods

Constructors

constructor

new Model(props?: Model | __type): Model

- Defined in orm/model.ts:8
Parameters
- Optional props: Model | __type
Returns Model

Properties

Protected model

model: any

Methods

belongsTo

belongsTo(model: Model): Model

- Defined in orm/model.ts:34
Parameters
- model: Model
Returns Model

getChildren

getChildren(model: any & Model): Model[]

- Defined in orm/model.ts:66
Get first level related children models

Parameters
- model: any & Model
Returns Model[]

getChildrenAll

getChildrenAll(): void

- Defined in orm/model.ts:85
Get recursively all descendant models from this model

Returns void

Private getForeignKeyColumnName

getForeignKeyColumnName(): string

- Defined in orm/model.ts:29
Returns string

getParent

getParent(model: any & Model): Model[]

- Defined in orm/model.ts:49
Parameters
- model: any & Model
Returns Model[]

hasChildren

hasChildren(): boolean

- Defined in orm/model.ts:122
Returns boolean

Protected insert

insert(model?: any): number | string

Inherited from Base.insert
- Defined in orm/base.ts:21
Parameters
- Optional model: any
Returns number | string

isSaved

isSaved(): boolean

- Defined in orm/model.ts:25
Returns boolean

remove

remove(model?: any): number

Inherited from Base.remove
- Defined in orm/base.ts:45
Parameters
- Optional model: any
Returns number

save

save(model?: any): number | string

Inherited from Base.save
- Defined in orm/base.ts:33
Parameters
- Optional model: any
Returns number | string

tableName

tableName(): string

Inherited from Base.tableName
- Defined in orm/base.ts:11
Returns string

Protected update

update(model?: any): number | string

Inherited from Base.update
- Defined in orm/base.ts:28
Parameters
- Optional model: any
Returns number | string

Static create

create(pojo: Object, modelClass: any): Model

- Defined in orm/model.ts:21
Factory for model instance creation

Parameters
- pojo: Object
  
  (plain old javascript object)
- modelClass: any
Returns Model

Static omitChildrenProps

omitChildrenProps(model: any): Model

- Defined in orm/model.ts:110
Makes related models properties not enumerable Use: if a model is fetched with all related (or children) models when this model is saved an error is thrown due to properties containing related models are not original model properties This function can be used to "hide" (not enumerate) these props and save the model

Parameters
- model: any
  
  returns {Model}
Returns Model

Generated using TypeDoc