Function deleteLocationHandler

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

  • Delete location handler

    Parameters

    • locationService: Pick<LocationDataService, "deleteLocation">

      injected service use to handle the location related operations

    • logger: Logger

      injected logger used to handle the logging

    • context: AdapterHandlerContext

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

      • params.id is required

    Returns Promise<adapter.AdapterHandlerResponse>

    204 Status No Content

    Description

    This handler is used to delete a location by applying the following steps in sequence:

    1. Get the locationId from params

    2. Delete the location (locationService.deleteLocation)

    3. Return 204

    Throws

    Error

    • id is missing from path

    Throws

    404 NBError Not Found

    • Location ${id} not found

    Throws

    500 NBError Internal Server Error

    • Error happen when delete location ${id} from database

Settings

Member Visibility

Theme

Generated using TypeDoc