MongoService

Base class for MongoDB service layers

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

abstract class MongoService<Doc extends MongoDocument = MongoDocument>

abstract class MongoService<Doc extends MongoDocument = MongoDocument>

\@RegisterMongoService('users')
export class Users extends MongoService<IUser> {
  \@RegisterMongoModel('users')
  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 });
  }
}

\@RegisterMongoService('users')
export class Users extends MongoService<IUser> {
  \@RegisterMongoModel('users')
  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 MongoServiceMongoService class

MongoService(db: Mongo, core: Core)

MongoService(db: Mongo, core: Core)

Showing members with Protected visibility and higher.

Doc

The document type this service manages

Doc extends MongoDocument = MongoDocument

Doc extends MongoDocument = MongoDocument

core

protected readonly core: Core

protected readonly core: Core

db

protected readonly db: Mongo

protected readonly db: Mongo

model

public readonly model: mongoose.Model<Doc>

public readonly model: mongoose.Model<Doc>