Class: TypeOrmCrudService<T>

Extends

TypeOrmCrudService<T>

Extended by

Type Parameters

Type Parameter
`T` extends `ObjectLiteral`

Constructors

new TypeOrmCrudService()

new TypeOrmCrudService<T>(repo): TypeOrmCrudService<T>

Parameters

Parameter	Type
`repo`	`Repository`<`T`>

Returns

TypeOrmCrudService<T>

Overrides

xTypeOrmCrudService<T>.constructor

Defined in

packages/nestjs-crud/src/services/typeorm-crud.service.ts:20 (opens in a new tab)

Properties

Property	Modifier	Type	Inherited from
`alias`	`readonly`	`string`	`xTypeOrmCrudService.alias`
`count`	`readonly`	(`options`?: `FindManyOptions`<`T`>) => `Promise`<`number`>	`xTypeOrmCrudService.count`
`crudQueryHelper`	`readonly`	`CrudQueryHelper`	-
`dbName`	`protected`	`"mysql"` \| `"mariadb"` \| `"postgres"` \| `"cockroachdb"` \| `"sqlite"` \| `"mssql"` \| `"sap"` \| `"oracle"` \| `"cordova"` \| `"nativescript"` \| `"react-native"` \| `"sqljs"` \| `"mongodb"` \| `"aurora-mysql"` \| `"aurora-postgres"` \| `"expo"` \| `"better-sqlite3"` \| `"capacitor"` \| `"spanner"`	`xTypeOrmCrudService.dbName`
`entityColumns`	`protected`	`string`[]	`xTypeOrmCrudService.entityColumns`
`entityColumnsHash`	`protected`	`ObjectLiteral`	`xTypeOrmCrudService.entityColumnsHash`
`entityHasDeleteColumn`	`protected`	`boolean`	`xTypeOrmCrudService.entityHasDeleteColumn`
`entityPrimaryColumns`	`protected`	`string`[]	`xTypeOrmCrudService.entityPrimaryColumns`
`entityRelationsHash`	`protected`	`Map`<`string`, `IAllowedRelation`>	`xTypeOrmCrudService.entityRelationsHash`
`entityType`	`readonly`	`ClassType`<`T`>	`xTypeOrmCrudService.entityType`
`find`	`readonly`	(`options`?: `FindManyOptions`<`T`>) => `Promise`<`T`[]>	`xTypeOrmCrudService.find`
`findOne`	`readonly`	(`options`: `FindOneOptions`<`T`>) => `Promise`<`null` \| `T`>	`xTypeOrmCrudService.findOne`
`repo`	`protected`	`Repository`<`T`>	`xTypeOrmCrudService.repo`
`sqlInjectionRegEx`	`protected`	`RegExp`[]	`xTypeOrmCrudService.sqlInjectionRegEx`

Methods

builderAddBrackets()

protected builderAddBrackets(builder, condition, brackets): void

Parameters

Parameter	Type
`builder`	`SelectQueryBuilder`<`T`>
`condition`	`SConditionKey`
`brackets`	`Brackets`

Returns

void

Inherited from

xTypeOrmCrudService.builderAddBrackets

Defined in

node_modules/@nestjsx/crud-typeorm/lib/typeorm-crud.service.d.ts:53

builderSetWhere()

protected builderSetWhere(builder, condition, field, value, operator?): void

Parameters

Parameter	Type
`builder`	`SelectQueryBuilder`<`T`>
`condition`	`SConditionKey`
`field`	`string`
`value`	`any`
`operator`?	`ComparisonOperator`

Returns

void

Inherited from

xTypeOrmCrudService.builderSetWhere

Defined in

node_modules/@nestjsx/crud-typeorm/lib/typeorm-crud.service.d.ts:54

createBuilder()

createBuilder(parsed, options, many?, withDeleted?): Promise<SelectQueryBuilder<T>>

Parameters

Parameter	Type
`parsed`	`ParsedRequestParams`
`options`	`CrudRequestOptions`
`many`?	`boolean`
`withDeleted`?	`boolean`

Returns

Promise<SelectQueryBuilder<T>>

Inherited from

xTypeOrmCrudService.createBuilder

Defined in

node_modules/@nestjsx/crud-typeorm/lib/typeorm-crud.service.d.ts:38

createMany()

createMany(req, dto, queryOptions?): Promise<T[]>

Parameters

Parameter	Type
`req`	`CrudRequest`
`dto`	`CreateManyDto`<`DeepPartial`<`T`>>
`queryOptions`?	`CrudQueryOptionsInterface`

Returns

Promise<T[]>

Overrides

xTypeOrmCrudService.createMany

Defined in

packages/nestjs-crud/src/services/typeorm-crud.service.ts:70 (opens in a new tab)

createOne()

createOne(req, dto, queryOptions?): Promise<T>

Parameters

Parameter	Type
`req`	`CrudRequest`
`dto`	`DeepPartial`<`T`>
`queryOptions`?	`CrudQueryOptionsInterface`

Returns

Promise<T>

Overrides

xTypeOrmCrudService.createOne

Defined in

packages/nestjs-crud/src/services/typeorm-crud.service.ts:85 (opens in a new tab)

createPageInfo()

createPageInfo(data, total, limit, offset): GetManyDefaultResponse<T>

Parameters

Parameter	Type
`data`	`T`[]
`total`	`number`
`limit`	`number`
`offset`	`number`

Returns

GetManyDefaultResponse<T>

Inherited from

xTypeOrmCrudService.createPageInfo

Defined in

node_modules/@nestjsx/crud/lib/services/crud-service.abstract.d.ts:15

decidePagination()

decidePagination(parsed, options): boolean

Parameters

Parameter	Type
`parsed`	`ParsedRequestParams`
`options`	`CrudRequestOptions`

Returns

boolean

Inherited from

xTypeOrmCrudService.decidePagination

Defined in

node_modules/@nestjsx/crud/lib/services/crud-service.abstract.d.ts:16

deleteOne()

deleteOne(req, queryOptions?): Promise<void | T>

Parameters

Parameter	Type
`req`	`CrudRequest`
`queryOptions`?	`CrudQueryOptionsInterface`

Returns

Promise<void | T>

Overrides

xTypeOrmCrudService.deleteOne

Defined in

packages/nestjs-crud/src/services/typeorm-crud.service.ts:130 (opens in a new tab)

doGetMany()

protected doGetMany(builder, query, options): Promise<GetManyDefaultResponse<T> | T[]>

Parameters

Parameter	Type
`builder`	`SelectQueryBuilder`<`T`>
`query`	`ParsedRequestParams`
`options`	`CrudRequestOptions`

Returns

Promise<GetManyDefaultResponse<T> | T[]>

Inherited from

xTypeOrmCrudService.doGetMany

Defined in

node_modules/@nestjsx/crud-typeorm/lib/typeorm-crud.service.d.ts:39

getAllowedColumns()

protected getAllowedColumns(columns, options): string[]

Parameters

Parameter	Type
`columns`	`string`[]
`options`	`QueryOptions`

Returns

string[]

Inherited from

xTypeOrmCrudService.getAllowedColumns

Defined in

node_modules/@nestjsx/crud-typeorm/lib/typeorm-crud.service.d.ts:43

getEntityColumns()

protected getEntityColumns(entityMetadata): object

Parameters

Parameter	Type
`entityMetadata`	`EntityMetadata`

Returns

object

Name	Type
`columns`	`string`[]
`primaryColumns`	`string`[]

Inherited from

xTypeOrmCrudService.getEntityColumns

Defined in

node_modules/@nestjsx/crud-typeorm/lib/typeorm-crud.service.d.ts:44

getFieldWithAlias()

protected getFieldWithAlias(field, sort?): string

Parameters

Parameter	Type
`field`	`string`
`sort`?	`boolean`

Returns

string

Inherited from

xTypeOrmCrudService.getFieldWithAlias

Defined in

node_modules/@nestjsx/crud-typeorm/lib/typeorm-crud.service.d.ts:58

getMany()

getMany(req, queryOptions?): Promise<T[] | CrudResultPaginatedInterface<T>>

Parameters

Parameter	Type
`req`	`CrudRequest`
`queryOptions`?	`CrudQueryOptionsInterface`

Returns

Promise<T[] | CrudResultPaginatedInterface<T>>

Overrides

xTypeOrmCrudService.getMany

Defined in

packages/nestjs-crud/src/services/typeorm-crud.service.ts:26 (opens in a new tab)

getOne()

getOne(req, queryOptions?): Promise<T>

Parameters

Parameter	Type
`req`	`CrudRequest`
`queryOptions`?	`CrudQueryOptionsInterface`

Returns

Promise<T>

Overrides

xTypeOrmCrudService.getOne

Defined in

packages/nestjs-crud/src/services/typeorm-crud.service.ts:56 (opens in a new tab)

getOneOrFail()

protected getOneOrFail(req, shallow?, withDeleted?): Promise<T>

Parameters

Parameter	Type
`req`	`CrudRequest`
`shallow`?	`boolean`
`withDeleted`?	`boolean`

Returns

Promise<T>

Inherited from

xTypeOrmCrudService.getOneOrFail

Defined in

node_modules/@nestjsx/crud-typeorm/lib/typeorm-crud.service.d.ts:41

getParamFilters()

getParamFilters(parsed): ObjectLiteral

Parameters

Parameter	Type
`parsed`	`ParsedRequestParams`

Returns

ObjectLiteral

Inherited from

xTypeOrmCrudService.getParamFilters

Defined in

node_modules/@nestjsx/crud-typeorm/lib/typeorm-crud.service.d.ts:37

getPrimaryParams()

getPrimaryParams(options): string[]

Parameters

Parameter	Type
`options`	`CrudRequestOptions`

Returns

string[]

Inherited from

xTypeOrmCrudService.getPrimaryParams

Defined in

node_modules/@nestjsx/crud/lib/services/crud-service.abstract.d.ts:19

getRelationMetadata()

protected getRelationMetadata(field, options): IAllowedRelation

Parameters

Parameter	Type
`field`	`string`
`options`	`JoinOption`

Returns

IAllowedRelation

Inherited from

xTypeOrmCrudService.getRelationMetadata

Defined in

node_modules/@nestjsx/crud-typeorm/lib/typeorm-crud.service.d.ts:48

getSelect()

protected getSelect(query, options): string[]

Parameters

Parameter	Type
`query`	`ParsedRequestParams`
`options`	`QueryOptions`

Returns

string[]

Overrides

xTypeOrmCrudService.getSelect

Defined in

packages/nestjs-crud/src/services/typeorm-crud.service.ts:210 (opens in a new tab)

getSkip()

getSkip(query, take): null | number

Parameters

Parameter	Type
`query`	`ParsedRequestParams`
`take`	`number`

Returns

null | number

Inherited from

xTypeOrmCrudService.getSkip

Defined in

node_modules/@nestjsx/crud/lib/services/crud-service.abstract.d.ts:18

getSort()

protected getSort(query, options): ObjectLiteral

Parameters

Parameter	Type
`query`	`ParsedRequestParams`
`options`	`QueryOptions`

Returns

ObjectLiteral

Inherited from

xTypeOrmCrudService.getSort

Defined in

node_modules/@nestjsx/crud-typeorm/lib/typeorm-crud.service.d.ts:57

getTake()

getTake(query, options): null | number

Parameters

Parameter	Type
`query`	`ParsedRequestParams`
`options`	`QueryOptions`

Returns

null | number

Inherited from

xTypeOrmCrudService.getTake

Defined in

node_modules/@nestjsx/crud/lib/services/crud-service.abstract.d.ts:17

mapOperatorsToQuery()

protected mapOperatorsToQuery(cond, param): object

Parameters

Parameter	Type
`cond`	`QueryFilter`
`param`	`any`

Returns

object

Name	Type
`params`	`ObjectLiteral`
`str`	`string`

Inherited from

xTypeOrmCrudService.mapOperatorsToQuery

Defined in

node_modules/@nestjsx/crud-typeorm/lib/typeorm-crud.service.d.ts:60

mapSort()

protected mapSort(sort): ObjectLiteral

Parameters

Parameter	Type
`sort`	`QuerySort`[]

Returns

ObjectLiteral

Inherited from

xTypeOrmCrudService.mapSort

Defined in

node_modules/@nestjsx/crud-typeorm/lib/typeorm-crud.service.d.ts:59

onInitMapEntityColumns()

protected onInitMapEntityColumns(): void

Returns

void

Inherited from

xTypeOrmCrudService.onInitMapEntityColumns

Defined in

node_modules/@nestjsx/crud-typeorm/lib/typeorm-crud.service.d.ts:40

prepareEntityBeforeSave()

protected prepareEntityBeforeSave(dto, parsed): T

Parameters

Parameter	Type
`dto`	`DeepPartial`<`T`>
`parsed`	`ParsedRequestParams`

Returns

T

Inherited from

xTypeOrmCrudService.prepareEntityBeforeSave

Defined in

node_modules/@nestjsx/crud-typeorm/lib/typeorm-crud.service.d.ts:42

recoverOne()

recoverOne(req, queryOptions?): Promise<T>

Parameters

Parameter	Type
`req`	`CrudRequest`
`queryOptions`?	`CrudQueryOptionsInterface`

Returns

Promise<T>

Overrides

xTypeOrmCrudService.recoverOne

Defined in

packages/nestjs-crud/src/services/typeorm-crud.service.ts:144 (opens in a new tab)

replaceOne()

replaceOne(req, dto, queryOptions?): Promise<T>

Parameters

Parameter	Type
`req`	`CrudRequest`
`dto`	`DeepPartial`<`T`>
`queryOptions`?	`CrudQueryOptionsInterface`

Returns

Promise<T>

Overrides

xTypeOrmCrudService.replaceOne

Defined in

packages/nestjs-crud/src/services/typeorm-crud.service.ts:115 (opens in a new tab)

setAndWhere()

protected setAndWhere(cond, i, builder): void

Parameters

Parameter	Type
`cond`	`QueryFilter`
`i`	`any`
`builder`	`SelectQueryBuilder`<`T`> \| `WhereExpression`

Returns

void

Inherited from

xTypeOrmCrudService.setAndWhere

Defined in

node_modules/@nestjsx/crud-typeorm/lib/typeorm-crud.service.d.ts:50

setJoin()

protected setJoin(cond, joinOptions, builder): boolean

Parameters

Parameter	Type
`cond`	`QueryJoin`
`joinOptions`	`JoinOptions`
`builder`	`SelectQueryBuilder`<`T`>

Returns

boolean

Overrides

xTypeOrmCrudService.setJoin

Defined in

packages/nestjs-crud/src/services/typeorm-crud.service.ts:162 (opens in a new tab)

setOrWhere()

protected setOrWhere(cond, i, builder): void

Parameters

Parameter	Type
`cond`	`QueryFilter`
`i`	`any`
`builder`	`SelectQueryBuilder`<`T`> \| `WhereExpression`

Returns

void

Inherited from

xTypeOrmCrudService.setOrWhere

Defined in

node_modules/@nestjsx/crud-typeorm/lib/typeorm-crud.service.d.ts:51

setSearchCondition()

protected setSearchCondition(builder, search, condition?): void

Parameters

Parameter	Type
`builder`	`SelectQueryBuilder`<`T`>
`search`	`SCondition`
`condition`?	`SConditionKey`

Returns

void

Inherited from

xTypeOrmCrudService.setSearchCondition

Defined in

node_modules/@nestjsx/crud-typeorm/lib/typeorm-crud.service.d.ts:52

setSearchFieldObjectCondition()

protected setSearchFieldObjectCondition(builder, condition, field, object): void

Parameters

Parameter	Type
`builder`	`SelectQueryBuilder`<`T`>
`condition`	`SConditionKey`
`field`	`string`
`object`	`any`

Returns

void

Inherited from

xTypeOrmCrudService.setSearchFieldObjectCondition

Defined in

node_modules/@nestjsx/crud-typeorm/lib/typeorm-crud.service.d.ts:55

throwBadRequestException()

throwBadRequestException(msg?): BadRequestException

Parameters

Parameter	Type
`msg`?	`any`

Returns

BadRequestException

Inherited from

xTypeOrmCrudService.throwBadRequestException

Defined in

node_modules/@nestjsx/crud/lib/services/crud-service.abstract.d.ts:13

throwNotFoundException()

throwNotFoundException(name): NotFoundException

Parameters

Parameter	Type
`name`	`string`

Returns

NotFoundException

Inherited from

xTypeOrmCrudService.throwNotFoundException

Defined in

node_modules/@nestjsx/crud/lib/services/crud-service.abstract.d.ts:14

transaction()

transaction(options?): TransactionProxy

Parameters

Parameter	Type
`options`?	`SafeTransactionOptionsInterface`

Returns

TransactionProxy

Defined in

packages/nestjs-crud/src/services/typeorm-crud.service.ts:158 (opens in a new tab)

updateOne()

updateOne(req, dto, queryOptions?): Promise<T>

Parameters

Parameter	Type
`req`	`CrudRequest`
`dto`	`DeepPartial`<`T`>
`queryOptions`?	`CrudQueryOptionsInterface`

Returns

Promise<T>

Overrides

xTypeOrmCrudService.updateOne

Defined in

packages/nestjs-crud/src/services/typeorm-crud.service.ts:100 (opens in a new tab)

CrudResponsePaginatedDto CrudAction