listAndCountTypes - Product Module Reference
BetaThis documentation provides a reference to the listAndCountTypes method. This belongs to the Product Module.
This method is used to retrieve a paginated list of product types along with the total count of available product types satisfying the provided filters.
Example
To retrieve a list of product types using their IDs:
import {
initialize as initializeProductModule,
} from "@medusajs/product"
async function retrieveProductTypes (ids: string[]) {
const productModule = await initializeProductModule()
const [productTypes, count] = await productModule.listAndCountTypes({
id: ids
})
// do something with the product types or return them
}
To specify attributes that should be retrieved within the product types:
import {
initialize as initializeProductModule,
} from "@medusajs/product"
async function retrieveProductTypes (ids: string[]) {
const productModule = await initializeProductModule()
const [productTypes, count] = await productModule.listAndCountTypes({
id: ids
}, {
select: ["value"]
})
// do something with the product types or return them
}
By default, only the first 15
records are retrieved. You can control pagination by specifying the skip
and take
properties of the config
parameter:
import {
initialize as initializeProductModule,
} from "@medusajs/product"
async function retrieveProductTypes (ids: string[], skip: number, take: number) {
const productModule = await initializeProductModule()
const [productTypes, count] = await productModule.listAndCountTypes({
id: ids
}, {
select: ["value"],
skip,
take
})
// do something with the product types or return them
}
You can also use the $and
or $or
properties of the filter
parameter to use and/or conditions in your filters. For example:
import {
initialize as initializeProductModule,
} from "@medusajs/product"
async function retrieveProductTypes (ids: string[], value: string, skip: number, take: number) {
const productModule = await initializeProductModule()
const [productTypes, count] = await productModule.listAndCountTypes({
$and: [
{
id: ids
},
{
value
}
]
}, {
select: ["value"],
skip,
take
})
// do something with the product types or return them
}
Parameters
filters
FilterableProductTypePropsThe filters to be applied on the retrieved product type.
filters
FilterableProductTypePropsconfig
FindConfig<ProductTypeDTO>The configurations determining how the product types are retrieved. Its properties, such as select
or relations
, accept the
attributes or relations associated with a product type.
config
FindConfig<ProductTypeDTO>select
or relations
, accept the
attributes or relations associated with a product type.sharedContext
ContextA context used to share resources, such as transaction manager, between the application and the module.
sharedContext
ContextReturns
The list of product types along with their total count.
Was this section helpful?