Typegoose: using plugins: mongoose-paginate

[kerolloz]

I am trying to use the paginate plugin but I don't get IntelliSense for the paginate() method provided by this plugin. Typescript complains about paginate() method Property 'paginate' does not exist on type 'ReturnModelType<typeof Dummy, unknown>'. Though, it works after transpilation.

import { Typegoose, plugin } from '@typegoose/typegoose';
import { FilterQuery, PaginateOptions, PaginateResult } from 'mongoose';
import mongoosePaginate from 'mongoose-paginate-v2';

@plugin(mongoosePaginate)
export class Dummy {
  @prop()
  name!: string;
}

I tried this solution https://github.com/szokodiakos/typegoose/issues/63. It somehow worked but it gives deprecation warning
(node:15629) DeprecationWarning: The Typegoose Class is deprecated, please try to remove it.
Anyway, It would be troublesome to add the paginate method every time I need to add pagination for a model.

Versions

• "@typegoose/typegoose": "^6.4.0",
• "mongoose": "^5.9.7",

[kerolloz]

This solution worked for me

import mongoosePaginate from 'mongoose-paginate-v2';
import { FilterQuery, PaginateOptions, PaginateResult } from 'mongoose';

type PaginateMethod<T> = (
  query?: FilterQuery<T>,
  options?: PaginateOptions,
  callback?: (err: any, result: PaginateResult<T>) => void,
) => Promise<PaginateResult<T>>;

@plugin(mongoosePaginate)
export class Dummy {
  @prop()
  name!: string;

  static paginate: PaginateMethod<Dummy>;
}

[hasezoey]

It somehow worked but it gives deprecation warning

you extended the deprecated (and useless) Typegoose class

---

from what i read, this issue is solved

[kerolloz]

@hasezoey

why should I add the static method every time?
I believe the @plugin() decorator should be responsible for that.

[hasezoey]

@kerolloz an decorator cant add an type, so you either need to do it for every class, or extend an class that has it defined

[kerolloz]

The problem with this approach is I still don't get IntelliSense until I write the static method again in the subclass.

import { plugin } from '@typegoose/typegoose';
import mongoosePaginate from 'mongoose-paginate-v2';


type PaginateMethod<T> = (
  query?: FilterQuery<T>,
  options?: PaginateOptions,
  callback?: (err: any, result: PaginateResult<T>) => void,
) => Promise<PaginateResult<T>>;

@plugin(mongoosePaginate)
export abstract class PaginatedModel {
  static paginate: PaginateMethod<PaginatedModel>;
}

export class Dummy extends PaginatedModel {
  @prop()
  name!: string;

  static paginate: PaginateMethod<Dummy>; // have to be repeated
}

[hasezoey]

functions that have just an type in an abstract class need to be implemented by all child classes

it should work when you just remove the abstract keyword (the class will persist anyway)