Function listProductsHandler

  • listProductsHandler(productService, paginationConfiguration, logger, context): Promise<adapter.AdapterHandlerResponse>

  • List all products (regardless of publication status) handler

    Parameters

    • productService: ProductDataService

      injected service use to handle the product related operations

    • paginationConfiguration: PaginationConfigurations
    • logger: Logger

      injected logger used to handle the logging

    • context: AdapterHandlerContext

      request context [headers, body, params, query].

    Returns Promise<adapter.AdapterHandlerResponse>

    200 Status Ok

    • data: products list

    Description

    This handler gets all the products regardless of the publication status.

    This handler is used to get a list of products by applying the following steps in sequence:

    1. Parse the query to get the pagination options (util.parsePaginatedListQuery)

    2. Check if the pagination options are valid

    3. Get the products list (productService.listPaginatedProducts)

    4. Return the products list

    Throws

    400 NBError Bad Request

    • error when parse paginated list query, ${error.message}
    • pagination must be set
    • Page size exceeds ${MAXIMUM_PAGE_SIZE} mbs

    Throws

    500 NBError Internal Server Error

    • Error happen when get products list from database

Settings

Member Visibility

Theme

Generated using TypeDoc