@vepler/http-sdk/dist/utils/errors.js

The definitive TypeScript SDK for UK property technology. Access comprehensive property data, school metrics, demographics, planning applications, and more through a single, powerful API.

"use strict";
/**
 * Standardized error message utilities for consistent error handling across the SDK
 */
Object.defineProperty(exports, "__esModule", { value: true });
exports.createRequiredParameterError = createRequiredParameterError;
exports.createMutuallyExclusiveError = createMutuallyExclusiveError;
exports.createEitherOrParameterError = createEitherOrParameterError;
exports.createConditionalParameterError = createConditionalParameterError;
/**
 * Creates a standardized required parameter error message
 * @param paramName - The name of the required parameter
 * @returns Formatted error message
 */
function createRequiredParameterError(paramName) {
    return "Parameter \"".concat(paramName, "\" is required");
}
/**
 * Creates a standardized mutually exclusive parameters error message
 * @param paramGroup1 - First group of parameters
 * @param paramGroup2 - Second group of parameters
 * @returns Formatted error message
 */
function createMutuallyExclusiveError(paramGroup1, paramGroup2) {
    return "Parameters ".concat(paramGroup1, " and ").concat(paramGroup2, " are mutually exclusive");
}
/**
 * Creates a standardized "either/or" parameter error message
 * @param paramGroup1 - First group of parameters
 * @param paramGroup2 - Second group of parameters
 * @returns Formatted error message
 */
function createEitherOrParameterError(paramGroup1, paramGroup2) {
    return "Either ".concat(paramGroup1, " or ").concat(paramGroup2, " must be provided");
}
/**
 * Creates a standardized conditional parameter error message
 * @param dependentParam - Parameter that depends on another
 * @param requiredParam - Parameter that is required when dependent is provided
 * @returns Formatted error message
 */
function createConditionalParameterError(dependentParam, requiredParam) {
    return "Parameter \"".concat(requiredParam, "\" is required when \"").concat(dependentParam, "\" is provided");
}
//# sourceMappingURL=errors.js.map