Class BaseUser

The User Entity is a data schema that represents a user within your application. It typically includes fields such as the user's name, email address, password, and other profile information.

Hierarchy

BaseEntity
- BaseUser

Implements

CurrentUser

Constructors

constructor

new BaseUser(): BaseUser
Returns BaseUser
Inherited from BaseEntity.constructor

Properties

`Optional`avatarUrl

avatarUrl?: MaybeNull<string>

User's avatar URL

Example

'https://example.com/avatar.png'

`Optional`clientId

clientId?: MaybeNull<string>

Client ID (for Apollo Studio)

createdAt

createdAt: Date

Date, when user was created.

`Optional`deletedAt

deletedAt?: MaybeNull<Date>

Date, when user was deleted.

email

email: string

Users's email. Must be unique.

Example

'[email protected]'

firstName

firstName: string

User's first name

Example

'John'

id

id: string

invitationStatus

invitationStatus: UserInvitationStatus

When user is invited to the system, it has one of the following statuses:

See

invitationStatusChanges

invitationStatusChanges: Promise<InvitationStatusChange[]>

`Optional`is2faEnabled

is2faEnabled?: MaybeNull<boolean>

Represent Two-Factor Authentication status.

`Optional`isOtpEnabled

isOtpEnabled?: MaybeNull<boolean>

Represent One-Time Password status.

lastName

lastName: string

User's last name

Example

'Doe'

lastSeen

lastSeen: Date

Date, when user made last request to the system.

`Optional`locale

locale?: MaybeNull<string>

User's locale in ISO 639-1 format. Use LanguagesModule to fetch lists with locales.

Example

'en'

`Optional`otpSecret

otpSecret?: MaybeNull<string>

Keep One-Time Password secret.

`Optional`parentUserId

parentUserId?: MaybeNull<string>

Parent user who was signed in as this user.

`Optional`passwordHash

passwordHash?: MaybeNull<string>

User's password hash. Generated from real password by bcrypt. When user logged in with password, password hash is compared with this field.

`Optional`patronymic

patronymic?: MaybeNull<string>

User's patronymic name

Example

'Ivanovich'

permissions

permissions: string[] = []

User's custom permissions. In general, permissions must be inherited from roles. But you can add custom permissions to user.

Example

[
 'js:core:episodes:create',
 'js:core:episodes:update'
]

`Optional`phoneNumber

phoneNumber?: MaybeNull<string>

User's phone number

Example

'+380501234567'

`Optional`referrer

referrer?: MaybeNull<string>

User's referrer. It can be email or any other identifier.

Example

'[email protected]'

resolvedPermissions

resolvedPermissions: ReadonlyResolvedPermission[] = []

User's resolved permissions. This array is used by authorization guards to check user's permissions. This array must be fullfilled by UserManager.resolve when user tries to make request.

Example

[
 {
   id: 'js:core:episodes:create',
   scopes: ['org#hcorg:xxxxxxxxxx']
 },
 ...
]

status

status: UserStatus

Users has two statuses: ACTIVE and DELETED.

ACTIVE - user is active and can signin to the system. DELETED - user is deleted and can't signin to the system.

See

`Optional`timezoneName

timezoneName?: MaybeNull<string>

User's timezone name in IANA format. Use TimezonesModule to fetch lists with timezones.

Example

'Europe/Kiev'

type

type: UserType

Users has two types: USER and SA.

See

updatedAt

updatedAt: Date

Date, when user was updated.

userToRoles

userToRoles: Promise<BaseUserToRole[]>

User's roles.

Accessors

fullName

get fullName(): string
User's full name computed from first and last name

Returns string
Example
```
'John Doe'
```
Implementation of CurrentUser.fullName
- Defined in libs/core/src/modules/users/user.entity.ts:129

isDeleted

get isDeleted(): boolean
Returns boolean
- Defined in libs/core/src/modules/users/user.entity.ts:91

`Static`target

get target(): EntityTarget<any>
Returns object that is managed by this repository. If this repository manages entity from schema, then it returns a name of that schema instead.

Returns EntityTarget<any>
Inherited from BaseEntity.target
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:67

Methods

hasId

hasId(): boolean
Checks if entity has an id. If entity composite compose ids, it will check them all.

Returns boolean
Inherited from BaseEntity.hasId
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:30

recover

recover(options?: SaveOptions): Promise<BaseUser>
Recovers a given entity in the database.
Parameters
- Optionaloptions: SaveOptions
Returns Promise<BaseUser>
Inherited from BaseEntity.recover
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:47

reload

reload(): Promise<void>
Reloads entity data from the database.

Returns Promise<void>
Inherited from BaseEntity.reload
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:51

remove

remove(options?: RemoveOptions): Promise<BaseUser>
Removes current entity from the database.
Parameters
- Optionaloptions: RemoveOptions
Returns Promise<BaseUser>
Inherited from BaseEntity.remove
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:39

save

save(options?: SaveOptions): Promise<BaseUser>
Saves current entity in the database. If entity does not exist in the database then inserts, otherwise updates.
Parameters
- Optionaloptions: SaveOptions
Returns Promise<BaseUser>
Inherited from BaseEntity.save
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:35

softRemove

softRemove(options?: SaveOptions): Promise<BaseUser>
Records the delete date of current entity.
Parameters
- Optionaloptions: SaveOptions
Returns Promise<BaseUser>
Inherited from BaseEntity.softRemove
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:43

`Static`average

average<T extends BaseEntity>(
    this: new () => T & typeof BaseEntity,
    columnName: PickKeysByType<T, number>,
    where: FindOptionsWhere<T>,
): Promise<null | number>
Return the AVG of a column
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
- columnName: PickKeysByType<T, number>
- where: FindOptionsWhere<T>
Returns Promise<null | number>
Inherited from BaseEntity.average
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:229

`Static`clear

clear<T extends BaseEntity>(
this: new () => T & typeof BaseEntity,
): Promise<void>
Clears all the data from the given table/collection (truncates/drops it).
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
Returns Promise<void>
Inherited from BaseEntity.clear
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:331

`Static`count

count<T extends BaseEntity>(
this: new () => T & typeof BaseEntity,
options?: FindManyOptions<T>,
): Promise<number>
Counts entities that match given options.
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
- Optionaloptions: FindManyOptions<T>
Returns Promise<number>
Inherited from BaseEntity.count
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:211

`Static`countBy

countBy<T extends BaseEntity>(
this: new () => T & typeof BaseEntity,
where: FindOptionsWhere<T>,
): Promise<number>
Counts entities that match given WHERE conditions.
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
- where: FindOptionsWhere<T>
Returns Promise<number>
Inherited from BaseEntity.countBy
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:217

`Static`create

create<T extends BaseEntity>(this: new () => T & typeof BaseEntity): T
Creates a new entity instance.
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
Returns T
Inherited from BaseEntity.create
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:88
create<T extends BaseEntity>(
this: new () => T & typeof BaseEntity,
entityLikeArray: DeepPartial<T>[],
): T[]
Creates a new entities and copies all entity properties from given objects into their new entities. Note that it copies only properties that present in entity schema.
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
- entityLikeArray: DeepPartial<T>[]
Returns T[]
Inherited from BaseEntity.create
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:95
create<T extends BaseEntity>(
this: new () => T & typeof BaseEntity,
entityLike: DeepPartial<T>,
): T
Creates a new entity instance and copies all entity properties from this object into a new entity. Note that it copies only properties that present in entity schema.
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
- entityLike: DeepPartial<T>
Returns T
Inherited from BaseEntity.create
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:102

`Static`createQueryBuilder

createQueryBuilder<T extends BaseEntity>(
this: new () => T & typeof BaseEntity,
alias?: string,
): SelectQueryBuilder<T>
Creates a new query builder that can be used to build a SQL query.
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
- Optionalalias: string
Returns SelectQueryBuilder<T>
Inherited from BaseEntity.createQueryBuilder
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:82

`Static`delete

delete<T extends BaseEntity>(
    this: new () => T & typeof BaseEntity,
    criteria:
        | string
        | number
        | string[]
        | Date
        | number[]
        | ObjectId
        | Date[]
        | ObjectId[]
        | FindOptionsWhere<T>,
): Promise<DeleteResult>
Deletes entities by a given criteria. Unlike remove method executes a primitive operation without cascades, relations and other operations included. Executes fast and efficient DELETE query. Does not check if entity exist in the database.
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
- criteria:
      | string
      | number
      | string[]
      | Date
      | number[]
      | ObjectId
      | Date[]
      | ObjectId[]
      | FindOptionsWhere<T>
Returns Promise<DeleteResult>
Inherited from BaseEntity.delete
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:193

`Static`exists

exists<T extends BaseEntity>(
this: new () => T & typeof BaseEntity,
options?: FindManyOptions<T>,
): Promise<boolean>
Checks whether any entity exists that matches the given options.
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
- Optionaloptions: FindManyOptions<T>
Returns Promise<boolean>
Inherited from BaseEntity.exists
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:199

`Static`existsBy

existsBy<T extends BaseEntity>(
this: new () => T & typeof BaseEntity,
where: FindOptionsWhere<T>,
): Promise<boolean>
Checks whether any entity exists that matches the given conditions.
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
- where: FindOptionsWhere<T>
Returns Promise<boolean>
Inherited from BaseEntity.existsBy
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:205

`Static`find

find<T extends BaseEntity>(
this: new () => T & typeof BaseEntity,
options?: FindManyOptions<T>,
): Promise<T[]>
Finds entities that match given options.
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
- Optionaloptions: FindManyOptions<T>
Returns Promise<T[]>
Inherited from BaseEntity.find
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:247

`Static`findAndCount

findAndCount<T extends BaseEntity>(
this: new () => T & typeof BaseEntity,
options?: FindManyOptions<T>,
): Promise<[T[], number]>
Finds entities that match given find options. Also counts all entities that match given conditions, but ignores pagination settings (from and take options).
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
- Optionaloptions: FindManyOptions<T>
Returns Promise<[T[], number]>
Inherited from BaseEntity.findAndCount
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:261

`Static`findAndCountBy

findAndCountBy<T extends BaseEntity>(
this: new () => T & typeof BaseEntity,
where: FindOptionsWhere<T>,
): Promise<[T[], number]>
Finds entities that match given WHERE conditions. Also counts all entities that match given conditions, but ignores pagination settings (from and take options).
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
- where: FindOptionsWhere<T>
Returns Promise<[T[], number]>
Inherited from BaseEntity.findAndCountBy
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:269

`Static`findBy

findBy<T extends BaseEntity>(
this: new () => T & typeof BaseEntity,
where: FindOptionsWhere<T>,
): Promise<T[]>
Finds entities that match given WHERE conditions.
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
- where: FindOptionsWhere<T>
Returns Promise<T[]>
Inherited from BaseEntity.findBy
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:253

`Static`findByIds

findByIds<T extends BaseEntity>(
this: new () => T & typeof BaseEntity,
ids: any[],
): Promise<T[]>
Finds entities by ids. Optionally find options can be applied.
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
- ids: any[]
Returns Promise<T[]>
Deprecated
use findBy method instead in conjunction with In operator, for example:

.findBy({ id: In([1, 2, 3]) })
Inherited from BaseEntity.findByIds
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:282

`Static`findOne

findOne<T extends BaseEntity>(
this: new () => T & typeof BaseEntity,
options: FindOneOptions<T>,
): Promise<null | T>
Finds first entity that matches given conditions.
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
- options: FindOneOptions<T>
Returns Promise<null | T>
Inherited from BaseEntity.findOne
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:288

`Static`findOneBy

findOneBy<T extends BaseEntity>(
this: new () => T & typeof BaseEntity,
where: FindOptionsWhere<T>,
): Promise<null | T>
Finds first entity that matches given conditions.
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
- where: FindOptionsWhere<T>
Returns Promise<null | T>
Inherited from BaseEntity.findOneBy
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:294

`Static`findOneById

findOneById<T extends BaseEntity>(
this: new () => T & typeof BaseEntity,
id: string | number | Date | ObjectId,
): Promise<null | T>
Finds first entity that matches given options.
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
- id: string | number | Date | ObjectId
Returns Promise<null | T>
Deprecated
use findOneBy method instead in conjunction with In operator, for example:

.findOneBy({ id: 1 // where "id" is your primary column name })
Inherited from BaseEntity.findOneById
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:306

`Static`findOneByOrFail

findOneByOrFail<T extends BaseEntity>(
this: new () => T & typeof BaseEntity,
where: FindOptionsWhere<T>,
): Promise<T>
Finds first entity that matches given conditions.
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
- where: FindOptionsWhere<T>
Returns Promise<T>
Inherited from BaseEntity.findOneByOrFail
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:318

`Static`findOneOrFail

findOneOrFail<T extends BaseEntity>(
this: new () => T & typeof BaseEntity,
options: FindOneOptions<T>,
): Promise<T>
Finds first entity that matches given conditions.
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
- options: FindOneOptions<T>
Returns Promise<T>
Inherited from BaseEntity.findOneOrFail
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:312

`Static`getId

getId<T extends BaseEntity>(
this: new () => T & typeof BaseEntity,
entity: T,
): any
Gets entity mixed id.
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
- entity: T
Returns any
Inherited from BaseEntity.getId
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:76

`Static`getRepository

getRepository<T extends BaseEntity>(
this: new () => T & typeof BaseEntity,
): Repository<T>
Gets current entity's Repository.
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
Returns Repository<T>
Inherited from BaseEntity.getRepository
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:59

`Static`hasId

hasId(entity: BaseEntity): boolean
Checks entity has an id. If entity composite compose ids, it will check them all.
Parameters
- entity: BaseEntity
Returns boolean
Inherited from BaseEntity.hasId
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:72

`Static`insert

insert<T extends BaseEntity>(
    this: new () => T & typeof BaseEntity,
    entity:
        | _QueryDeepPartialEntity<ObjectLiteral extends T ? unknown : T>
        | _QueryDeepPartialEntity<ObjectLiteral extends T ? unknown : T>[],
): Promise<InsertResult>
Inserts a given entity into the database. Unlike save method executes a primitive operation without cascades, relations and other operations included. Executes fast and efficient INSERT query. Does not check if entity exist in the database, so query will fail if duplicate entity is being inserted.
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
- entity:
  | _QueryDeepPartialEntity<ObjectLiteral extends T ? unknown : T>
  | _QueryDeepPartialEntity<ObjectLiteral extends T ? unknown : T>[]
Returns Promise<InsertResult>
Inherited from BaseEntity.insert
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:167

`Static`maximum

maximum<T extends BaseEntity>(
    this: new () => T & typeof BaseEntity,
    columnName: PickKeysByType<T, number>,
    where: FindOptionsWhere<T>,
): Promise<null | number>
Return the MAX of a column
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
- columnName: PickKeysByType<T, number>
- where: FindOptionsWhere<T>
Returns Promise<null | number>
Inherited from BaseEntity.maximum
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:241

`Static`merge

merge<T extends BaseEntity>(
    this: new () => T & typeof BaseEntity,
    mergeIntoEntity: T,
    ...entityLikes: DeepPartial<T>[],
): T
Merges multiple entities (or entity-like objects) into a given entity.
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
- mergeIntoEntity: T
- ...entityLikes: DeepPartial<T>[]
Returns T
Inherited from BaseEntity.merge
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:108

`Static`minimum

minimum<T extends BaseEntity>(
    this: new () => T & typeof BaseEntity,
    columnName: PickKeysByType<T, number>,
    where: FindOptionsWhere<T>,
): Promise<null | number>
Return the MIN of a column
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
- columnName: PickKeysByType<T, number>
- where: FindOptionsWhere<T>
Returns Promise<null | number>
Inherited from BaseEntity.minimum
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:235

`Static`preload

preload<T extends BaseEntity>(
this: new () => T & typeof BaseEntity,
entityLike: DeepPartial<T>,
): Promise<undefined | T>
Creates a new entity from the given plain javascript object. If entity already exist in the database, then it loads it (and everything related to it), replaces all values with the new ones from the given object and returns this new entity. This new entity is actually a loaded from the db entity with all properties replaced from the new object.

Note that given entity-like object must have an entity id / primary key to find entity by. Returns undefined if entity with given id was not found.
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
- entityLike: DeepPartial<T>
Returns Promise<undefined | T>
Inherited from BaseEntity.preload
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:120

`Static`query

query<T extends BaseEntity>(
    this: new () => T & typeof BaseEntity,
    query: string,
    parameters?: any[],
): Promise<any>
Executes a raw SQL query and returns a raw database results. Raw query execution is supported only by relational databases (MongoDB is not supported).
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
- query: string
- Optionalparameters: any[]
Returns Promise<any>
Inherited from BaseEntity.query
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:325

`Static`remove

remove<T extends BaseEntity>(
    this: new () => T & typeof BaseEntity,
    entities: T[],
    options?: RemoveOptions,
): Promise<T[]>
Removes a given entities from the database.
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
- entities: T[]
- Optionaloptions: RemoveOptions
Returns Promise<T[]>
Inherited from BaseEntity.remove
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:140
remove<T extends BaseEntity>(
    this: new () => T & typeof BaseEntity,
    entity: T,
    options?: RemoveOptions,
): Promise<T>
Removes a given entity from the database.
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
- entity: T
- Optionaloptions: RemoveOptions
Returns Promise<T>
Inherited from BaseEntity.remove
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:146

`Static`save

save<T extends BaseEntity>(
    this: new () => T & typeof BaseEntity,
    entities: DeepPartial<T>[],
    options?: SaveOptions,
): Promise<T[]>
Saves all given entities in the database. If entities do not exist in the database then inserts, otherwise updates.
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
- entities: DeepPartial<T>[]
- Optionaloptions: SaveOptions
Returns Promise<T[]>
Inherited from BaseEntity.save
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:127
save<T extends BaseEntity>(
    this: new () => T & typeof BaseEntity,
    entity: DeepPartial<T>,
    options?: SaveOptions,
): Promise<T>
Saves a given entity in the database. If entity does not exist in the database then inserts, otherwise updates.
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
- entity: DeepPartial<T>
- Optionaloptions: SaveOptions
Returns Promise<T>
Inherited from BaseEntity.save
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:134

`Static`softRemove

softRemove<T extends BaseEntity>(
    this: new () => T & typeof BaseEntity,
    entities: T[],
    options?: SaveOptions,
): Promise<T[]>
Records the delete date of all given entities.
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
- entities: T[]
- Optionaloptions: SaveOptions
Returns Promise<T[]>
Inherited from BaseEntity.softRemove
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:152
softRemove<T extends BaseEntity>(
    this: new () => T & typeof BaseEntity,
    entity: T,
    options?: SaveOptions,
): Promise<T>
Records the delete date of a given entity.
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
- entity: T
- Optionaloptions: SaveOptions
Returns Promise<T>
Inherited from BaseEntity.softRemove
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:158

`Static`sum

sum<T extends BaseEntity>(
    this: new () => T & typeof BaseEntity,
    columnName: PickKeysByType<T, number>,
    where: FindOptionsWhere<T>,
): Promise<null | number>
Return the SUM of a column
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
- columnName: PickKeysByType<T, number>
- where: FindOptionsWhere<T>
Returns Promise<null | number>
Inherited from BaseEntity.sum
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:223

`Static`update

update<T extends BaseEntity>(
    this: new () => T & typeof BaseEntity,
    criteria:
        | string
        | number
        | string[]
        | Date
        | number[]
        | ObjectId
        | Date[]
        | ObjectId[]
        | FindOptionsWhere<T>,
    partialEntity: QueryDeepPartialEntity<T>,
): Promise<UpdateResult>
Updates entity partially. Entity can be found by a given conditions. Unlike save method executes a primitive operation without cascades, relations and other operations included. Executes fast and efficient UPDATE query. Does not check if entity exist in the database.
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
- criteria:
      | string
      | number
      | string[]
      | Date
      | number[]
      | ObjectId
      | Date[]
      | ObjectId[]
      | FindOptionsWhere<T>
- partialEntity: QueryDeepPartialEntity<T>
Returns Promise<UpdateResult>
Inherited from BaseEntity.update
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:176

`Static`upsert

upsert<T extends BaseEntity>(
    this: new () => T & typeof BaseEntity,
    entityOrEntities:
        | _QueryDeepPartialEntity<ObjectLiteral extends T ? unknown : T>
        | _QueryDeepPartialEntity<ObjectLiteral extends T ? unknown : T>[],
    conflictPathsOrOptions: string[] | UpsertOptions<T>,
): Promise<InsertResult>
Inserts a given entity into the database, unless a unique constraint conflicts then updates the entity Unlike save method executes a primitive operation without cascades, relations and other operations included. Executes fast and efficient INSERT ... ON CONFLICT DO UPDATE/ON DUPLICATE KEY UPDATE query.
Type Parameters
- T extends BaseEntity
Parameters
- this: new () => T & typeof BaseEntity
- entityOrEntities:
  | _QueryDeepPartialEntity<ObjectLiteral extends T ? unknown : T>
  | _QueryDeepPartialEntity<ObjectLiteral extends T ? unknown : T>[]
- conflictPathsOrOptions: string[] | UpsertOptions<T>
Returns Promise<InsertResult>
Inherited from BaseEntity.upsert
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:184

`Static`useDataSource

useDataSource(dataSource: null | DataSource): void
Sets DataSource to be used by entity.
Parameters
- dataSource: null | DataSource
Returns void
Inherited from BaseEntity.useDataSource
- Defined in node_modules/typeorm/repository/BaseEntity.d.ts:55

Class BaseUser

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns BaseUser

Properties

OptionalavatarUrl

Example

OptionalclientId

createdAt

OptionaldeletedAt

email

Example

firstName

Example

id

invitationStatus

See

invitationStatusChanges

Optionalis2faEnabled

OptionalisOtpEnabled

lastName

Example

lastSeen

Optionallocale

Example

OptionalotpSecret

OptionalparentUserId

OptionalpasswordHash

Optionalpatronymic

Example

permissions

Example

OptionalphoneNumber

Example

Optionalreferrer

Example

resolvedPermissions

Example

status

See

OptionaltimezoneName

Example

type

See

updatedAt

userToRoles

Accessors

fullName

Returns string

Example

isDeleted

Returns boolean

Statictarget

Returns EntityTarget<any>

Methods

hasId

Returns boolean

recover

Parameters

Returns Promise<BaseUser>

reload

Returns Promise<void>

remove

Parameters

Returns Promise<BaseUser>

save

Parameters

Returns Promise<BaseUser>

softRemove

Parameters

Returns Promise<BaseUser>

Staticaverage

Type Parameters

`Optional`avatarUrl

`Optional`clientId

`Optional`deletedAt

`Optional`is2faEnabled

`Optional`isOtpEnabled

`Optional`locale

`Optional`otpSecret

`Optional`parentUserId

`Optional`passwordHash

`Optional`patronymic

`Optional`phoneNumber

`Optional`referrer

`Optional`timezoneName

`Static`target

`Static`average

`Static`clear

`Static`count

`Static`countBy

`Static`create

`Static`createQueryBuilder

`Static`delete

`Static`exists

`Static`existsBy

`Static`find

`Static`findAndCount

`Static`findAndCountBy

`Static`findBy

`Static`findByIds

`Static`findOne

`Static`findOneBy

`Static`findOneById