@openactive/models-ts/lib/schema/URL.d.ts

JavaScript/TypeScript implementation of OpenActive's data model

import * as Joi from 'joi';
import { OaValidationError } from '../oaValidationError';
/**
 * schema:URL
 */
export declare type URL = {
    '@type': 'URL';
    '@context'?: string | string[];
    /**
     * A unique url based identifier for the record
     */
    '@id'?: string;
};
/**
 * schema:URL
 *
 * This differs from URL because it also allows for objects that have the type of a model that
 * sub-classes this model. e.g. `Event_OrSubClass` allows `Event`s as well as `ScheduledSession`s, `SessionSeries`,
 * etc.
 */
export declare type URLOrSubClass = URL;
/**
 * schema:URL - Validation schema (w/ JOI)
 */
export declare const URLJoiSchema: Joi.ObjectSchema;
/**
 * schema:URL - Validation schema (w/ JOI)
 *
 * This differs from URLJoiSchema because it also allows for objects that have the type of a model that
 * sub-classes this model. e.g. `Event.OrSubClassJoiSchema` allows `Event`s as well as `ScheduledSession`s,
 * `SessionSeries`, etc.
 */
export declare const URLOrSubClassJoiSchema: Joi.AlternativesSchema;
/**
 * Runtime validator for schema:URL.
 *
 * If some data has a structure which matches a schema:URL, 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 maybeURL = validateURL(req.body); // `req.body` will have type `any` or `unknown`
 * if (maybeURL instanceof OaValidationError) {
 *   // From this point on, `maybeURL` will have type `OaValidationError`
 *   const error = maybeURL;
 *   // Do something with the error. Maybe ignore it? Or log it? Or throw? Up to you.
 * }
 * // From this point on, `maybeURL` will have type `URL`
 * const uRL = maybeURL;
 * ```
 */
export declare function validateURL(maybeURL: unknown): URL | OaValidationError;