@istock/iswork / Exports / BaseModel

Class: BaseModel

基础模型

Implements

• IBaseModel

Table of contents

Constructors

• constructor

Properties

• createQueryBuilder
• dataSource
• generateId

Methods

• save
• toObject
• createMany
• createModel
• createOne
• deleteById
• deleteMany
• findOneById
• getRepository
• query
• run
• updateById
• updateMany
• useDataSource

Constructors

constructor

• new BaseModel(): BaseModel

Returns

BaseModel

Properties

createQueryBuilder

▪ Static Readonly createQueryBuilder: (params?: string | IQueryParamsOptions) => QueryBuilder

Type declaration

▸ (params?): QueryBuilder

QueryBuilder工厂方法，创建一个QueryBuilder实例

Parameters

Name	Type	Description
params?	string | IQueryParamsOptions	查询参数选项

Returns

QueryBuilder

Defined in

src/packages/iswork/src/orm/model/base-model.ts:25

---

dataSource

▪ Static Protected dataSource: DataSource<TDataSourceType>

Defined in

src/packages/iswork/src/orm/model/base-model.ts:24

---

generateId

▪ Static Readonly generateId: FESnowflake

Defined in

src/packages/iswork/src/orm/model/base-model.ts:26

Methods

save

▸ save<This>(this): Promise<null | string | number>

保存当前模型数据

Type parameters

Name	Type
This	extends BaseModel

Parameters

Name	Type
this	This

Returns

Promise<null | string | number>

Implementation of

IBaseModel.save

Defined in

src/packages/iswork/src/orm/model/base-model.ts:31

---

toObject

▸ toObject<This>(this): TModelData<This>

模型实例转换成数据

Type parameters

Name	Type
This	extends BaseModel

Parameters

Name	Type
this	This

Returns

TModelData<This>

Implementation of

IBaseModel.toObject

Defined in

src/packages/iswork/src/orm/model/base-model.ts:44

---

createMany

▸ createMany<Model>(this, dataOrModels): Promise<(string | number)[]>

Type parameters

Name	Type
Model	extends typeof BaseModel

Parameters

Name	Type
this	Model
dataOrModels	TModelCreate<InstanceType<Model>>[] | TModelData<InstanceType<Model>>[] | InstanceType<Model>[]

Returns

Promise<(string | number)[]>

Defined in

src/packages/iswork/src/orm/model/base-model.ts:100

---

createModel

▸ createModel<Model>(this, data): InstanceType<Model>

Type parameters

Name	Type
Model	extends typeof BaseModel

Parameters

Name	Type
this	Model
data	TModelCreate<InstanceType<Model>>

Returns

InstanceType<Model>

Defined in

src/packages/iswork/src/orm/model/base-model.ts:60

---

createOne

▸ createOne<Model>(this, dataOrModel): Promise<null | string | number>

Type parameters

Name	Type
Model	extends typeof BaseModel

Parameters

Name	Type
this	Model
dataOrModel	InstanceType<Model> | TModelCreate<InstanceType<Model>> | TModelData<InstanceType<Model>>

Returns

Promise<null | string | number>

Defined in

src/packages/iswork/src/orm/model/base-model.ts:83

---

deleteById

▸ deleteById<Model>(this, id): Promise<boolean>

Type parameters

Name	Type
Model	extends typeof BaseModel

Parameters

Name	Type
this	Model
id	string | number

Returns

Promise<boolean>

Defined in

src/packages/iswork/src/orm/model/base-model.ts:151

---

deleteMany

▸ deleteMany<Model>(this, query): Promise<boolean>

Type parameters

Name	Type
Model	extends typeof BaseModel

Parameters

Name	Type
this	Model
query	TOrmQuery

Returns

Promise<boolean>

Defined in

src/packages/iswork/src/orm/model/base-model.ts:146

---

findOneById

▸ findOneById<Model>(this, id): Promise<TModelData<InstanceType<Model>>>

Type parameters

Name	Type
Model	extends typeof BaseModel

Parameters

Name	Type
this	Model
id	string | number

Returns

Promise<TModelData<InstanceType<Model>>>

Defined in

src/packages/iswork/src/orm/model/base-model.ts:156

---

getRepository

▸ getRepository(): Promise<Repository>

Returns

Promise<Repository>

Defined in

src/packages/iswork/src/orm/model/base-model.ts:56

---

query

▸ query<Model>(this, query): Promise<TModelData<InstanceType<Model>>[]>

Type parameters

Name	Type
Model	extends typeof BaseModel

Parameters

Name	Type
this	Model
query	TOrmQuery

Returns

Promise<TModelData<InstanceType<Model>>[]>

Defined in

src/packages/iswork/src/orm/model/base-model.ts:78

---

run

▸ run<Result>(...executeArgs): Promise<Result>

连接器原始执行操作

Type parameters

Name	Type
Result	unknown

Parameters

Name	Type
...executeArgs	unknown[]

Returns

Promise<Result>

Defined in

src/packages/iswork/src/orm/model/base-model.ts:73

---

updateById

▸ updateById<Model>(this, id, dataOrModel): Promise<boolean>

Type parameters

Name	Type
Model	extends typeof BaseModel

Parameters

Name	Type
this	Model
id	string | number
dataOrModel	InstanceType<Model> | TModelUpdate<InstanceType<Model>>

Returns

Promise<boolean>

Defined in

src/packages/iswork/src/orm/model/base-model.ts:123

---

updateMany

▸ updateMany<Model>(this, updateDataLists): Promise<boolean>

Type parameters

Name	Type
Model	extends typeof BaseModel

Parameters

Name	Type
this	Model
updateDataLists	TModelUpdate<InstanceType<Model>>[]

Returns

Promise<boolean>

Defined in

src/packages/iswork/src/orm/model/base-model.ts:138

---

useDataSource

▸ useDataSource(dataSource): void

Parameters

Name	Type
dataSource	DataSource<TDataSourceType>

Returns

void

Defined in

src/packages/iswork/src/orm/model/base-model.ts:52