Classplugin-mongoosev0.7.0

MongooseService

Base class for MongoDB service layers

Provides typed access to MongoDB collections through Mongoose models. Services are automatically registered with the Mongoose plugin when instantiated.

abstract class MongooseService<
    Doc extends MongooseDocument = MongooseDocument
>

\@RegisterMongooseService('users')
export class Users extends MongooseService<IUser> {
  public static schema = new mongoose.Schema<IUser>({
    username: { type: String, required: true, unique: true }
  });

  // Custom methods here
  public async findByUsername(username: string) {
    return this.model.findOne({ username });
  }
}

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the MongooseService class

MongooseService(
    db: Mongoose,
    core: CoreBase,
    model: mongoose.Model<
        Doc,
        {},
        {},
        mongoose.ObtainSchemaGeneric<mongoose.Schema<Doc>, "TVirtuals">
    >
)

Showing members with Protected visibility and higher.

Doc

The document type this service manages

Doc extends MongooseDocument = MongooseDocument

core

protected readonly core: CoreBase

db

protected readonly db: Mongoose

model

public readonly model: mongoose.Model<Doc, {}, {}, mongoose.ObtainSchemaGeneric<mongoose.Schema<Doc>, 'TVirtuals'>>