Method deleteOne

libs/common/src/TypegooseQueryService.ts:295–301

* Delete an entity by `id`. * * @example * * ```ts * const deletedTodo = await this.service.deleteOne(1); * ``` * * @param id - The `id` of the entity to delete. * @param opts - Additional filter to use when finding the entity to delete.

(id: string, opts?: DeleteOneOptions<Entity>)

   * @param opts - Additional filter to use when finding the entity to delete.
   */
  async deleteOne(id: string, opts?: DeleteOneOptions<Entity>): Promise<Entity> {
    const doc = await this.Model.findOneAndDelete(this.mergeFilterWithId(id, opts?.filter))
    if (doc) {
      return doc.toObject(this.documentToObjectOptions) as Entity
    }
    throw new NotFoundException(`Unable to find ${this.Model.modelName} with id: ${id}`)
  }

  /**
   * Delete multiple records with a `@ptc-org/nestjs-query-core` `Filter`.