Function listLocationsHandler

  • listLocationsHandler(locationService, paginationConfiguration, logger, context): Promise<adapter.AdapterHandlerResponse>

  • Get location list handler

    Parameters

    • locationService: Pick<LocationDataService, "listPaginatedLocations" | "normalizeLocationResponses">

      injected service use to handle the location related operations

      • listPaginatedLocations
      • normalizeLocationResponses
    • 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: location list

    Description

    This handler is used to get a list of locations 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 location list (locationService.listPaginatedLocations)

    4. Return the location list (locationService.normalizeLocationResponses)

    Throws

    400 NBError Bad Request

    • error when parse paginated list query, ${error.message}

    Throws

    400 NBError Bad Request

    • pagination must be set

    Throws

    400 NBError Bad Request

    • Page size exceeds ${MAXIMUM_PAGE_SIZE} mbs

    Throws

    500 NBError Internal Server Error

    • Error happen when get location list from database

Settings

Member Visibility

Theme

Generated using TypeDoc