Function preferenceBelongsToUser

  • preferenceBelongsToUser(preferenceService, userIdTargetField, preferenceIdTargetField, logger, context): Promise<StatusCodes>

  • Preference belongs to user validator

    Parameters

    • preferenceService: Pick<PreferenceDataService, "getPreferenceById">

      injected preference service used to get the preference by id

    • userIdTargetField: TargetField

      target field for userId

    • preferenceIdTargetField: TargetField

      target field for preferenceId

    • logger: Logger

      injected logger used to handle the logging

    • context: AdapterHandlerContext

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

    Returns Promise<StatusCodes>

    200 Status OK

    Description

    This validator will check if the preference belongs to the user by applying the following steps in sequence:

    1. Get userId from context.params

    2. Get preferenceId from context.params

    3. Check if the preference exists

    4. Check if the preference belongs to the user

    Throws

    404 NBError Not Found

    • preference cannot be found

    Throws

    403 NBError Forbidden

    • preference does not belong to the user

Settings

Member Visibility

Theme

Generated using TypeDoc