@openactive/models-ts/lib/schema/BusinessEntityType.js

JavaScript/TypeScript implementation of OpenActive's data model

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.validateBusinessEntityType = exports.BusinessEntityTypeJoiSchema = void 0;
// This file was generated
const Joi = require("joi");
const oaValidationError_1 = require("../oaValidationError");
/**
 * schema:BusinessEntityType - Validation schema (w/ JOI)
 *
 * A business entity type is a conceptual entity representing the legal form, the size, the main line of business, the position in the value chain, or any combination thereof, of an organization or business person.\n\nCommonly used values:\n\n* http://purl.org/goodrelations/v1#Business\n* http://purl.org/goodrelations/v1#Enduser\n* http://purl.org/goodrelations/v1#PublicInstitution\n* http://purl.org/goodrelations/v1#Reseller
 *
 *
 */
exports.BusinessEntityTypeJoiSchema = Joi.string().valid();
/**
 * Runtime validator for schema:BusinessEntityType.
 *
 * If some data has one of the values of the schema:BusinessEntityType enum, it will be returned with the correct type.
 * Otherwise, this function returns an `OAValidationError` with details about why the data does not match.
 *
 * Use this to e.g. check a JSON object received in an HTTP request. Example usage (for an express request handler):
 *
 * ```ts
 * const maybeBusinessEntityType = validateBusinessEntityType(req.body); // `req.body` will have type `any` or `unknown`
 * if (maybeBusinessEntityType instanceof OaValidationError) {
 *   // From this point on, `maybeBusinessEntityType` will have type `OaValidationError`
 *   const error = maybeBusinessEntityType;
 *   // Do something with the error. Maybe ignore it? Or log it? Or throw? Up to you.
 * }
 * // From this point on, `maybeBusinessEntityType` will have type `BusinessEntityType`
 * const businessEntityType = maybeBusinessEntityType;
 * ```
 */
function validateBusinessEntityType(maybeBusinessEntityType) {
    const { value, error } = exports.BusinessEntityTypeJoiSchema.validate(maybeBusinessEntityType);
    if (error) {
        return new oaValidationError_1.OaValidationError('BusinessEntityType', maybeBusinessEntityType, error);
    }
    /* Joi does not implement TS Type Guards, so TS does not implicitly know that this has now been validated
    to have the right type. Therefore, we just cast it to the right type. */
    return value;
}
exports.validateBusinessEntityType = validateBusinessEntityType;