Function basicLoadClassPattern

test/types/loadclass.test.ts:5–45

()

// Basic usage of `loadClass` with TypeScript
function basicLoadClassPattern() {
  class MyClass {
    myMethod() { return 42; }
    static myStatic() { return 42; }
    get myVirtual() { return 42; }
  }

  const schema = new Schema({ property1: String });
  schema.loadClass(MyClass);

  interface MySchema {
    property1: string;
  }


  // `loadClass()` does NOT update TS types automatically.
  // So we must manually combine schema fields + class members.
  type MyCombined = MySchema & MyClass;

  // The model type must include statics from the class
  type MyCombinedModel = Model<MyCombined> & typeof MyClass;

  // A document must combine Mongoose Document + class + schema
  type MyCombinedDocument = Document & MyCombined;

  // Cast schema to satisfy TypeScript
  const MyModel = model<MyCombinedDocument, MyCombinedModel>('MyClass', schema as any);

  // Static function should work
  expect(MyModel.myStatic()).type.toBe<number>();

  // Instance method should work
  const doc = new MyModel();
  expect(doc.myMethod()).type.toBe<number>();

  // Getter should work
  expect(doc.myVirtual).type.toBe<number>();

  // Schema property should be typed
  expect(doc.property1).type.toBe<string>();
}


// Using `this` typing in class methods