@openactive/models-ts/src/schema/HealthAspectEnumeration.ts

JavaScript/TypeScript implementation of OpenActive's data model

// This file was generated
import * as Joi from 'joi';
import { OaValidationError } from '../oaValidationError';

/**
 * schema:HealthAspectEnumeration
 *
 * HealthAspectEnumeration enumerates several aspects of health content online, each of which might be described using [[hasHealthAspect]] and [[HealthTopicContent]].
 */
export type HealthAspectEnumeration = 
  
  | 'https://schema.org/SeeDoctorHealthAspect'
  | 'https://schema.org/ScreeningHealthAspect'
  | 'https://schema.org/CausesHealthAspect'
  | 'https://schema.org/StagesHealthAspect'
  | 'https://schema.org/SafetyHealthAspect'
  | 'https://schema.org/BenefitsHealthAspect'
  | 'https://schema.org/ContagiousnessHealthAspect'
  | 'https://schema.org/SelfCareHealthAspect'
  | 'https://schema.org/PatientExperienceHealthAspect'
  | 'https://schema.org/MayTreatHealthAspect'
  | 'https://schema.org/EffectivenessHealthAspect'
  | 'https://schema.org/SymptomsHealthAspect'
  | 'https://schema.org/RelatedTopicsHealthAspect'
  | 'https://schema.org/PrognosisHealthAspect'
  | 'https://schema.org/TreatmentsHealthAspect'
  | 'https://schema.org/HowOrWhereHealthAspect'
  | 'https://schema.org/TypesHealthAspect'
  | 'https://schema.org/SideEffectsHealthAspect'
  | 'https://schema.org/AllergiesHealthAspect'
  | 'https://schema.org/RisksOrComplicationsHealthAspect'
  | 'https://schema.org/HowItWorksHealthAspect'
  | 'https://schema.org/IngredientsHealthAspect'
  | 'https://schema.org/PreventionHealthAspect'
  | 'https://schema.org/GettingAccessHealthAspect'
  | 'https://schema.org/PregnancyHealthAspect'
  | 'https://schema.org/MisconceptionsHealthAspect'
  | 'https://schema.org/OverviewHealthAspect'
  | 'https://schema.org/UsageOrScheduleHealthAspect'
  | 'https://schema.org/LivingWithHealthAspect'
  ;

/**
 * schema:HealthAspectEnumeration - Validation schema (w/ JOI)
 *
 * HealthAspectEnumeration enumerates several aspects of health content online, each of which might be described using [[hasHealthAspect]] and [[HealthTopicContent]].
 */
export const HealthAspectEnumerationJoiSchema = Joi.string().valid(
  'https://schema.org/SeeDoctorHealthAspect',
  'https://schema.org/ScreeningHealthAspect',
  'https://schema.org/CausesHealthAspect',
  'https://schema.org/StagesHealthAspect',
  'https://schema.org/SafetyHealthAspect',
  'https://schema.org/BenefitsHealthAspect',
  'https://schema.org/ContagiousnessHealthAspect',
  'https://schema.org/SelfCareHealthAspect',
  'https://schema.org/PatientExperienceHealthAspect',
  'https://schema.org/MayTreatHealthAspect',
  'https://schema.org/EffectivenessHealthAspect',
  'https://schema.org/SymptomsHealthAspect',
  'https://schema.org/RelatedTopicsHealthAspect',
  'https://schema.org/PrognosisHealthAspect',
  'https://schema.org/TreatmentsHealthAspect',
  'https://schema.org/HowOrWhereHealthAspect',
  'https://schema.org/TypesHealthAspect',
  'https://schema.org/SideEffectsHealthAspect',
  'https://schema.org/AllergiesHealthAspect',
  'https://schema.org/RisksOrComplicationsHealthAspect',
  'https://schema.org/HowItWorksHealthAspect',
  'https://schema.org/IngredientsHealthAspect',
  'https://schema.org/PreventionHealthAspect',
  'https://schema.org/GettingAccessHealthAspect',
  'https://schema.org/PregnancyHealthAspect',
  'https://schema.org/MisconceptionsHealthAspect',
  'https://schema.org/OverviewHealthAspect',
  'https://schema.org/UsageOrScheduleHealthAspect',
  'https://schema.org/LivingWithHealthAspect',
);

/**
 * Runtime validator for schema:HealthAspectEnumeration.
 *
 * If some data has one of the values of the schema:HealthAspectEnumeration 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 maybeHealthAspectEnumeration = validateHealthAspectEnumeration(req.body); // `req.body` will have type `any` or `unknown`
 * if (maybeHealthAspectEnumeration instanceof OaValidationError) {
 *   // From this point on, `maybeHealthAspectEnumeration` will have type `OaValidationError`
 *   const error = maybeHealthAspectEnumeration;
 *   // Do something with the error. Maybe ignore it? Or log it? Or throw? Up to you.
 * }
 * // From this point on, `maybeHealthAspectEnumeration` will have type `HealthAspectEnumeration`
 * const healthAspectEnumeration = maybeHealthAspectEnumeration;
 * ```
 */
export function validateHealthAspectEnumeration(maybeHealthAspectEnumeration: unknown): HealthAspectEnumeration | OaValidationError {
  const { value, error } = HealthAspectEnumerationJoiSchema.validate(maybeHealthAspectEnumeration);
  if (error) {
    return new OaValidationError('HealthAspectEnumeration', maybeHealthAspectEnumeration, 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 as HealthAspectEnumeration;
}