listAndCount - Stock Location Next Module Reference

This documentation provides a reference to the listAndCount method. This belongs to the Stock Location Next Module.

This method retrieves a paginated list of stock locations along with the total count of available stock locations satisfying the provided filters.

Example

To retrieve a list of stock locations using their IDs:

const [stockLocations, count] =
  await stockLocationModuleService.list({
    id: ["sloc_123", "sloc_321"],
  })

To specify relations that should be retrieved within the stock locations:

const [stockLocations, count] =
  await stockLocationModuleService.list(
    {
      id: ["sloc_123", "sloc_321"],
    },
    {
      relations: ["address"],
    }
  )

By default, only the first 10 records are retrieved. You can control pagination by specifying the skip and take properties of the config parameter:

const [stockLocations, count] =
  await stockLocationModuleService.list(
    {
      id: ["sloc_123", "sloc_321"],
    },
    {
      relations: ["address"],
      take: 20,
      skip: 2,
    }
  )

Parameters

selectorFilterableStockLocationPropsRequired

The filters to apply on the retrieved stock locations.

configFindConfig<StockLocationDTO>

The configurations determining how the stock location is retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a stock location.

contextContext

A context used to share resources, such as transaction manager, between the application and the module.

Returns

PromisePromise<[StockLocationDTO[], number]>Required

The list of stock locations along with their total count.