@openactive/models-ts
Version:
JavaScript/TypeScript implementation of OpenActive's data model
40 lines (39 loc) • 1.86 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.validateBrokerType = exports.BrokerTypeJoiSchema = void 0;
// This file was generated
const Joi = require("joi");
const oaValidationError_1 = require("../oaValidationError");
/**
* BrokerType - Validation schema (w/ JOI)
*/
exports.BrokerTypeJoiSchema = Joi.string().valid('https://openactive.io/AgentBroker', 'https://openactive.io/NoBroker', 'https://openactive.io/ResellerBroker');
/**
* Runtime validator for BrokerType.
*
* If some data has one of the values of the BrokerType 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 maybeBrokerType = validateBrokerType(req.body); // `req.body` will have type `any` or `unknown`
* if (maybeBrokerType instanceof OaValidationError) {
* // From this point on, `maybeBrokerType` will have type `OaValidationError`
* const error = maybeBrokerType;
* // Do something with the error. Maybe ignore it? Or log it? Or throw? Up to you.
* }
* // From this point on, `maybeBrokerType` will have type `BrokerType`
* const brokerType = maybeBrokerType;
* ```
*/
function validateBrokerType(maybeBrokerType) {
const { value, error } = exports.BrokerTypeJoiSchema.validate(maybeBrokerType);
if (error) {
return new oaValidationError_1.OaValidationError('BrokerType', maybeBrokerType, 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.validateBrokerType = validateBrokerType;