serializr/src/api/setDefaultModelSchema.ts

Serialize and deserialize complex object graphs to JSON

import { invariant, isModelSchema } from "../utils/utils";
import { Clazz, ModelSchema } from "./types";

/**
 * Sets the default model schema for class / constructor function.
 * Everywhere where a model schema is required as argument, this class / constructor function
 * can be passed in as well (for example when using `object` or `ref`.
 *
 * When passing an instance of this class to `serialize`, it is not required to pass the model schema
 * as first argument anymore, because the default schema will be inferred from the instance type.
 *
 * @param clazz class or constructor function
 * @param modelSchema - a model schema
 * @returns model schema
 */
export default function setDefaultModelSchema<T>(clazz: Clazz<T>, modelSchema: ModelSchema<T>) {
    invariant(isModelSchema(modelSchema), `expected modelSchema, got ${modelSchema}`);
    (clazz as any).serializeInfo = modelSchema;
    return modelSchema;
}