Class Category

Category Entity

Description

Represents a category for organizing surveys. Each category is uniquely named and can contain multiple surveys. It is created by a user and timestamps are automatically handled.

Param: name

is the entity's name in the database (category).

This class defines the structure of the category entity in the database:

  • id: unique identifier for the category.
  • name: unique name for the category.
  • user: the user who created this category.
  • surveys: surveys that belong to this category.
  • createdAt: timestamp of when the category was created.
  • updatedAt: timestamp of the last update.

Example

const category = new Category()
category.name = "Satisfaction"
category.user = currentUser
await category.save()

Decorators used:

  • @Entity(): defines the table.
  • @PrimaryGeneratedColumn(): auto-generates the primary key.
  • @Column(): maps properties to columns.
  • @OneToOne() / @OneToMany(): defines relations.
  • @ManyToOne(): defines the relations to Category and User.
  • @Field(): exposes fields in GraphQL schema.

Hierarchy

  • BaseEntity
    • Category

Constructors

constructor

Properties

createdAt createdBy id name surveys updatedAt

Accessors

target

Methods

hasId recover reload remove save softRemove average clear count countBy create createQueryBuilder delete exists existsBy find findAndCount findAndCountBy findBy findByIds findOne findOneBy findOneById findOneByOrFail findOneOrFail getId getRepository hasId insert maximum merge minimum preload query remove save softRemove sum update upsert useDataSource

Constructors

constructor

Properties

createdAt

createdAt: Date

Timestamp when the category was created

Description

Automatically set on insertion.

createdBy

createdBy: User

User who created the category

Description

Many relation to the User entity.

id

id: number

Unique identifier for the category

Description

Auto-generated primary key.

name

name: string

Name of the survey category

Description

A short, unique label used to classify surveys.

surveys

surveys: Survey[]

Surveys belonging to this category

Description

One-to-many relation to the Survey entity.

updatedAt

updatedAt: Date

Timestamp when the category was last updated

Description

Automatically updated on change.

Accessors

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>

Methods

hasId

  • hasId(): boolean

  • Checks if entity has an id. If entity composite compose ids, it will check them all.

    Returns boolean

recover

  • recover(options?): Promise<Category>

  • Recovers a given entity in the database.

    Parameters

    • Optional options: SaveOptions

    Returns Promise<Category>

reload

  • reload(): Promise<void>

  • Reloads entity data from the database.

    Returns Promise<void>

remove

  • remove(options?): Promise<Category>

  • Removes current entity from the database.

    Parameters

    • Optional options: RemoveOptions

    Returns Promise<Category>

save

  • save(options?): Promise<Category>

  • Saves current entity in the database. If entity does not exist in the database then inserts, otherwise updates.

    Parameters

    • Optional options: SaveOptions

    Returns Promise<Category>

softRemove

  • softRemove(options?): Promise<Category>

  • Records the delete date of current entity.

    Parameters

    • Optional options: SaveOptions

    Returns Promise<Category>

Static average

  • average<T>(this, columnName, where): Promise<null | number>

  • Return the AVG of a column

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity
    • columnName: PickKeysByType<T, number>
    • where: FindOptionsWhere<T>

    Returns Promise<null | number>

Static clear

  • clear<T>(this): Promise<void>

  • Clears all the data from the given table/collection (truncates/drops it).

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity

    Returns Promise<void>

Static count

  • count<T>(this, options?): Promise<number>

  • Counts entities that match given options.

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity
    • Optional options: FindManyOptions<T>

    Returns Promise<number>

Static countBy

  • countBy<T>(this, where): Promise<number>

  • Counts entities that match given WHERE conditions.

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity
    • where: FindOptionsWhere<T>

    Returns Promise<number>

Static create

  • create<T>(this): T

  • Creates a new entity instance.

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity

    Returns T

  • create<T>(this, entityLikeArray): 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<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity
    • entityLikeArray: DeepPartial<T>[]

    Returns T[]

  • create<T>(this, entityLike): 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<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity
    • entityLike: DeepPartial<T>

    Returns T

Static createQueryBuilder

  • createQueryBuilder<T>(this, alias?): SelectQueryBuilder<T>

  • Creates a new query builder that can be used to build a SQL query.

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity
    • Optional alias: string

    Returns SelectQueryBuilder<T>

Static delete

  • delete<T>(this, criteria): 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<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity
    • criteria: string | number | string[] | Date | number[] | ObjectId | Date[] | ObjectId[] | FindOptionsWhere<T>

    Returns Promise<DeleteResult>

Static exists

  • exists<T>(this, options?): Promise<boolean>

  • Checks whether any entity exists that matches the given options.

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity
    • Optional options: FindManyOptions<T>

    Returns Promise<boolean>

Static existsBy

  • existsBy<T>(this, where): Promise<boolean>

  • Checks whether any entity exists that matches the given conditions.

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity
    • where: FindOptionsWhere<T>

    Returns Promise<boolean>

Static find

  • find<T>(this, options?): Promise<T[]>

  • Finds entities that match given options.

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity
    • Optional options: FindManyOptions<T>

    Returns Promise<T[]>

Static findAndCount

  • findAndCount<T>(this, options?): 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<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity
    • Optional options: FindManyOptions<T>

    Returns Promise<[T[], number]>

Static findAndCountBy

  • findAndCountBy<T>(this, where): 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<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity
    • where: FindOptionsWhere<T>

    Returns Promise<[T[], number]>

Static findBy

  • findBy<T>(this, where): Promise<T[]>

  • Finds entities that match given WHERE conditions.

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity
    • where: FindOptionsWhere<T>

    Returns Promise<T[]>

Static findByIds

  • findByIds<T>(this, ids): Promise<T[]>

  • Finds entities by ids. Optionally find options can be applied.

    Type Parameters

    • T extends BaseEntity<T>

    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]) })

Static findOne

  • findOne<T>(this, options): Promise<null | T>

  • Finds first entity that matches given conditions.

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity
    • options: FindOneOptions<T>

    Returns Promise<null | T>

Static findOneBy

  • findOneBy<T>(this, where): Promise<null | T>

  • Finds first entity that matches given conditions.

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity
    • where: FindOptionsWhere<T>

    Returns Promise<null | T>

Static findOneById

  • findOneById<T>(this, id): Promise<null | T>

  • Finds first entity that matches given options.

    Type Parameters

    • T extends BaseEntity<T>

    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 })

Static findOneByOrFail

  • findOneByOrFail<T>(this, where): Promise<T>

  • Finds first entity that matches given conditions.

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity
    • where: FindOptionsWhere<T>

    Returns Promise<T>

Static findOneOrFail

  • findOneOrFail<T>(this, options): Promise<T>

  • Finds first entity that matches given conditions.

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity
    • options: FindOneOptions<T>

    Returns Promise<T>

Static getId

  • getId<T>(this, entity): any

  • Gets entity mixed id.

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity
    • entity: T

    Returns any

Static getRepository

  • getRepository<T>(this): Repository<T>

  • Gets current entity's Repository.

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity

    Returns Repository<T>

Static hasId

  • hasId(entity): boolean

  • Checks entity has an id. If entity composite compose ids, it will check them all.

    Parameters

    • entity: BaseEntity

    Returns boolean

Static insert

  • insert<T>(this, entity): 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<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity
    • entity: _QueryDeepPartialEntity<ObjectLiteral extends T
          ? unknown
          : T> | _QueryDeepPartialEntity<ObjectLiteral extends T
          ? unknown
          : T>[]

    Returns Promise<InsertResult>

Static maximum

  • maximum<T>(this, columnName, where): Promise<null | number>

  • Return the MAX of a column

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity
    • columnName: PickKeysByType<T, number>
    • where: FindOptionsWhere<T>

    Returns Promise<null | number>

Static merge

  • merge<T>(this, mergeIntoEntity, ...entityLikes): T

  • Merges multiple entities (or entity-like objects) into a given entity.

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity
    • mergeIntoEntity: T
    • Rest ...entityLikes: DeepPartial<T>[]

    Returns T

Static minimum

  • minimum<T>(this, columnName, where): Promise<null | number>

  • Return the MIN of a column

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity
    • columnName: PickKeysByType<T, number>
    • where: FindOptionsWhere<T>

    Returns Promise<null | number>

Static preload

  • preload<T>(this, entityLike): 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<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity
    • entityLike: DeepPartial<T>

    Returns Promise<undefined | T>

Static query

  • query<T>(this, query, parameters?): 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<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity
    • query: string
    • Optional parameters: any[]

    Returns Promise<any>

Static remove

  • remove<T>(this, entities, options?): Promise<T[]>

  • Removes a given entities from the database.

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity
    • entities: T[]
    • Optional options: RemoveOptions

    Returns Promise<T[]>

  • remove<T>(this, entity, options?): Promise<T>

  • Removes a given entity from the database.

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity
    • entity: T
    • Optional options: RemoveOptions

    Returns Promise<T>

Static save

  • save<T>(this, entities, options?): 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<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity
    • entities: DeepPartial<T>[]
    • Optional options: SaveOptions

    Returns Promise<T[]>

  • save<T>(this, entity, options?): 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<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity
    • entity: DeepPartial<T>
    • Optional options: SaveOptions

    Returns Promise<T>

Static softRemove

  • softRemove<T>(this, entities, options?): Promise<T[]>

  • Records the delete date of all given entities.

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity
    • entities: T[]
    • Optional options: SaveOptions

    Returns Promise<T[]>

  • softRemove<T>(this, entity, options?): Promise<T>

  • Records the delete date of a given entity.

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity
    • entity: T
    • Optional options: SaveOptions

    Returns Promise<T>

Static sum

  • sum<T>(this, columnName, where): Promise<null | number>

  • Return the SUM of a column

    Type Parameters

    • T extends BaseEntity<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity
    • columnName: PickKeysByType<T, number>
    • where: FindOptionsWhere<T>

    Returns Promise<null | number>

Static update

  • update<T>(this, criteria, partialEntity): 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<T>

    Parameters

    • this: (new () => T) & typeof BaseEntity
    • criteria: string | number | string[] | Date | number[] | ObjectId | Date[] | ObjectId[] | FindOptionsWhere<T>
    • partialEntity: _QueryDeepPartialEntity<ObjectLiteral extends T
          ? unknown
          : T>

    Returns Promise<UpdateResult>

Static upsert

  • upsert<T>(this, entityOrEntities, conflictPathsOrOptions): 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<T>

    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>

Static useDataSource

  • useDataSource(dataSource): void

  • Sets DataSource to be used by entity.

    Parameters

    • dataSource: null | DataSource

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcreatedAtcreatedByidnamesurveysupdatedAttargethasIdrecoverreloadremovesavesoftRemoveaverageclearcountcountBycreatecreateQueryBuilderdeleteexistsexistsByfindfindAndCountfindAndCountByfindByfindByIdsfindOnefindOneByfindOneByIdfindOneByOrFailfindOneOrFailgetIdgetRepositoryhasIdinsertmaximummergeminimumpreloadqueryremovesavesoftRemovesumupdateupsertuseDataSource