/// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// /// import * as mongoose from 'mongoose'; import 'reflect-metadata'; import { setGlobalOptions } from './globalOptions'; import type { AnyParamConstructor, BeAnObject, DocumentType, IModelOptions, Ref, ReturnModelType, SubDocumentType, ArraySubDocumentType } from './types'; export { mongoose, setGlobalOptions }; export { setLogLevel, LogLevels } from './logSettings'; export * from './prop'; export * from './hooks'; export * from './plugin'; export * from './indexes'; export * from './searchIndexes'; export * from './modelOptions'; export * from './queryMethod'; export * from './typeguards'; export * as defaultClasses from './defaultClasses'; export * as errors from './internal/errors'; export * as types from './types'; export { DocumentType, Ref, ReturnModelType, SubDocumentType, ArraySubDocumentType }; export { getClass, getName } from './internal/utils'; export { Severity, PropType } from './internal/constants'; /** * Build a Model From a Class * @param cl The Class to build a Model from * @param options Overwrite Options, like for naming or general SchemaOptions the class gets compiled with * @returns The finished Model * @public * @example * ```ts * class ClassName {} * * const NameModel = getModelForClass(ClassName); * ``` */ export declare function getModelForClass, QueryHelpers = BeAnObject>(cl: U, options?: IModelOptions): ReturnModelType; /** * Get Model from internal cache * @param key Model's name key * @example * ```ts * class ClassName {} * getModelForClass(ClassName); // build the model * const NameModel = getModelWithString("ClassName"); * ``` */ export declare function getModelWithString, QueryHelpers = BeAnObject>(key: string): undefined | ReturnModelType; /** * Generates a Mongoose schema out of class props, iterating through all parents * @param cl The Class to build a Schema from * @param options Overwrite Options, like for naming or general SchemaOptions the class gets compiled with * @returns Returns the Build Schema * @example * ```ts * class ClassName {} * const NameSchema = buildSchema(ClassName); * const NameModel = mongoose.model("Name", NameSchema); * ``` */ export declare function buildSchema>(cl: U, options?: IModelOptions): mongoose.Schema>>; /** * Add a Class-Model Pair to the Typegoose Cache * This can be used to add custom Models to Typegoose, with the type information of "cl" * Note: no guarrantee that the type information is fully correct when used manually * @param model The Model to store * @param cl The Class to store * @param options Overwrite existingMongoose or existingConnection * @example * ```ts * class ClassName {} * * const schema = buildSchema(ClassName); * // modifications to the schema can be done * const model = addModelToTypegoose(mongoose.model("Name", schema), ClassName); * ``` */ export declare function addModelToTypegoose, QueryHelpers = BeAnObject>(model: mongoose.Model, cl: U, options?: { existingMongoose?: mongoose.Mongoose; existingConnection?: any; disableCaching?: boolean; }): ReturnModelType; /** * Deletes a existing model so that it can be overwritten with another model * (deletes from mongoose.connection and typegoose models cache and typegoose constructors cache) * @param name The Model's mongoose name * @example * ```ts * class ClassName {} * const NameModel = getModelForClass(ClassName); * deleteModel("ClassName"); * ``` */ export declare function deleteModel(name: string): void; /** * Delete a model, with the given class * Same as "deleteModel", only that it can be done with the class instead of the name * @param cl The Class to delete the model from * @example * ```ts * class ClassName {} * const NameModel = getModelForClass(ClassName); * deleteModelWithClass(ClassName); * ``` */ export declare function deleteModelWithClass>(cl: U): void; /** * Build a Model from the given Class and add it as a discriminator onto "from" * @param from The Model to add the new discriminator model to * @param cl The Class to make a discriminator model from * @param options Overwrite ModelOptions (Merged with ModelOptions from class) * @example * ```ts * class Main { * @prop({ ref: () => BaseDiscriminator }) * public discriminators?: Ref; * } * * class BaseDiscriminator { * @prop() * public propertyOnAllDiscriminators?: string; * } * * class AnotherDiscriminator { * @prop() * public someValue?: string; * } * * const MainModel = getModelForClass(Main); * * const BaseDiscriminatorModel = getModelFroClass(BaseDiscriminator); * const AnotherDiscriminatorModel = getDiscriminatorModelForClass(BaseDiscriminatorModel, AnotherDiscriminator); * // add other discriminator models the same way as "AnotherDiscriminatorModel" * ``` */ export declare function getDiscriminatorModelForClass, QueryHelpers = BeAnObject>(from: mongoose.Model, cl: U, options?: IModelOptions): ReturnModelType; /** * Build a Model from the given Class and add it as a discriminator onto "from" * @param from The Model to add the new discriminator model to * @param cl The Class to make a discriminator model from * @param value The Identifier to use to differentiate documents (default: cl.name) * @example * ```ts * class Main { * @prop({ ref: () => BaseDiscriminator }) * public discriminators?: Ref; * } * * class BaseDiscriminator { * @prop() * public propertyOnAllDiscriminators?: string; * } * * class AnotherDiscriminator { * @prop() * public someValue?: string; * } * * const MainModel = getModelForClass(Main); * * const BaseDiscriminatorModel = getModelFroClass(BaseDiscriminator); * const AnotherDiscriminatorModel = getDiscriminatorModelForClass(BaseDiscriminatorModel, AnotherDiscriminator); * // add other discriminator models the same way as "AnotherDiscriminatorModel" * ``` */ export declare function getDiscriminatorModelForClass, QueryHelpers = BeAnObject>(from: mongoose.Model, cl: U, value?: string): ReturnModelType; /** * Build a Model from the given Class and add it as a discriminator onto "from" * @param from The Model to add the new discriminator model to * @param cl The Class to make a discriminator model from * @param value The Identifier to use to differentiate documents (default: cl.name) * @param options Overwrite ModelOptions (Merged with ModelOptions from class) * @example * ```ts * class Main { * @prop({ ref: () => BaseDiscriminator }) * public discriminators?: Ref; * } * * class BaseDiscriminator { * @prop() * public propertyOnAllDiscriminators?: string; * } * * class AnotherDiscriminator { * @prop() * public someValue?: string; * } * * const MainModel = getModelForClass(Main); * * const BaseDiscriminatorModel = getModelFroClass(BaseDiscriminator); * const AnotherDiscriminatorModel = getDiscriminatorModelForClass(BaseDiscriminatorModel, AnotherDiscriminator); * // add other discriminator models the same way as "AnotherDiscriminatorModel" * ``` */ export declare function getDiscriminatorModelForClass, QueryHelpers = BeAnObject>(from: mongoose.Model, cl: U, value?: string, options?: IModelOptions): ReturnModelType; /** * Use this class if raw mongoose for a path is wanted * It is still recommended to use the typegoose classes directly * @see Using `Passthrough`, the paths created will also result as an `Schema` (since mongoose 6.0), see {@link https://github.com/Automattic/mongoose/issues/7181 Mongoose#7181} * @example * ```ts * class Dummy { * @prop({ type: () => new Passthrough({ somePath: String }) }) * public somepath: { somePath: string }; * } * * class Dummy { * @prop({ type: () => new Passthrough({ somePath: String }, true) }) * public somepath: { somePath: string }; * } * ``` */ export declare class Passthrough { raw: any; direct: boolean; /** * Use this like `new mongoose.Schema()` * @param raw The Schema definition * @param direct Directly insert "raw", instead of using "type" (this will not apply any other inner options) */ constructor(raw: any, direct?: boolean); }