Interface ListsRepository

modelName

countDocuments

• countDocuments(query?: FilterQuery<BaseList>): Promise<number>

• Count the number of documents matching the query.

  Parameters

  • Optionalquery: FilterQuery<BaseList>

  Returns Promise<number>

  • A promise that resolves to the count of matching documents.

create

• create(entity: BaseList): Promise<Saved<BaseList>>

• Create a new entity.

  Parameters

  • entity: BaseList

    The entity to create.

  Returns Promise<Saved<BaseList>>

  • A promise that resolves to the saved entity.

createMany

• createMany(entity: BaseList[], options?: CreateManyOptions): Promise<string[]>

• Create multiple entities.

  Parameters

  • entity: BaseList[]

    An array of entities to create.
  • Optionaloptions: CreateManyOptions

  Returns Promise<string[]>

  • A promise that resolves to an array of created entity IDs.

deleteById

• deleteById(id: string): Promise<null | Saved<BaseList>>

• Soft delete an entity by its ID. This operation marks the entity as deleted without permanently destroying the record.

  Parameters

  • id: string

    The ID of the entity to delete. @returns- A promise that resolves to the deleted entity or null if not found.

  Returns Promise<null | Saved<BaseList>>

destroyById

• destroyById(id: string): Promise<null | Saved<BaseList>>

• Destroy an entity by its ID (permanently deletes it).

  Parameters

  • id: string

    The ID of the entity to destroy.

  Returns Promise<null | Saved<BaseList>>

  • A promise that resolves to the destroyed entity or null if not found.

findById

• findById(
      id: string,
      fields?: SelectQuery<BaseList>[],
      ListQueryOptions?: ListQueryOptions<BaseList>,
  ): Promise<null | Saved<BaseList>>

• Find an entity by its ID.

  Parameters

  • id: string

    The ID of the entity to find.
  • Optionalfields: SelectQuery<BaseList>[]

    Fields to select in the returned entity.
  • OptionalListQueryOptions: ListQueryOptions<BaseList>

    Options for listing queries.

  Returns Promise<null | Saved<BaseList>>

  • A promise that resolves to the found entity or null if not found.

findOne

• findOne(
      query?: FilterQuery<BaseList>,
      fields?: SelectQuery<BaseList>[],
      ListQueryOptions?: ListQueryOptions<BaseList>,
  ): Promise<null | Saved<BaseList>>

• Find one entity matching the query.

  Parameters

  • Optionalquery: FilterQuery<BaseList>
  • Optionalfields: SelectQuery<BaseList>[]
  • OptionalListQueryOptions: ListQueryOptions<BaseList>

  Returns Promise<null | Saved<BaseList>>

  • A promise that resolves to the found entity or null if not found.

list

• list(
      query?: FilterQuery<BaseList>,
      fields?: SelectQuery<BaseList>[],
      ListQueryOptions?: ListQueryOptions<BaseList>,
  ): Promise<Saved<BaseList>[]>

• List entities matching the query.

  Parameters

  • Optionalquery: FilterQuery<BaseList>

    The query to filter documents.
  • Optionalfields: SelectQuery<BaseList>[]

    Fields to select in the returned entities.
  • OptionalListQueryOptions: ListQueryOptions<BaseList>

    Options for listing queries.

  Returns Promise<Saved<BaseList>[]>

  • A promise that resolves to an array of found entities.

paginate

• paginate(
      options?: PaginateQueryOptions<BaseList>,
  ): Promise<PaginationResponse<Saved<BaseList>>>

• Retrieve paginated results. Only intended for use with the admin portal for performance reasons.

  Parameters

  • Optionaloptions: PaginateQueryOptions<BaseList>

    The pagination options

  Returns Promise<PaginationResponse<Saved<BaseList>>>

updateById

• updateById(
      id: string,
      entity: PartialQuery<BaseList>,
      options?: UpdateOptions,
  ): Promise<null | Saved<BaseList>>

• Update an entity by its ID.

  Parameters

  • id: string

    The ID of the entity to update.
  • entity: PartialQuery<BaseList>

    The partial entity to update.
  • Optionaloptions: UpdateOptions

  Returns Promise<null | Saved<BaseList>>

  • A promise that resolves to the updated entity or null if not found.

updateMany

• updateMany(
      filter: FilterQuery<BaseList>,
      update: PartialQuery<BaseList>,
  ): Promise<number>

• Update multiple entities matching the filter.

  Parameters

  • filter: FilterQuery<BaseList>

    The filter to match documents.
  • update: PartialQuery<BaseList>

    The partial update to apply.

  Returns Promise<number>

  • A promise that resolves to the number of documents updated.

updateOne

• updateOne(
      filter: FilterQuery<BaseList>,
      update: PartialQuery<BaseList>,
      options?: UpdateOneOptions,
  ): Promise<null | Saved<BaseList>>

• Update a single entity matching the filter.

  Parameters

  • filter: FilterQuery<BaseList>

    The filter to match documents.
  • update: PartialQuery<BaseList>

    The partial update to apply.
  • Optionaloptions: UpdateOneOptions

    Options for updating a single document.

  Returns Promise<null | Saved<BaseList>>

  | null>} - A promise that resolves to the updated entity or null if not found.

upsertOne

• upsertOne(
      filter: FilterQuery<BaseList>,
      entity: PartialQuery<BaseList>,
  ): Promise<null | string>

• Upsert a single record based on certain criteria.

  Parameters

  • filter: FilterQuery<BaseList>

    The filter to find the record to update or insert.
  • entity: PartialQuery<BaseList>

    The entity to upsert.

  Returns Promise<null | string>

  The return types of this method align with the MongoDB UpdateResult interface

  • Returns models.baseModel.Saved<T>['_id'] if the document did not exist (an upsert took place).
  • Returns null if the document did exist before the upsert operation.