Як використовувати TypeScript з Mongoose для визначення типів запитів?

8 Березня 2024 в 01:19 38

При розробці додатків на Node.js з використанням бази даних MongoDB, однією з найпопулярніших бібліотек для взаємодії з базою є Mongoose. TypeScript, як статично типізована мова програмування, може значно полегшити роботу з Mongoose, забезпечуючи перевірку типів на етапі розробки та підвищуючи безпеку коду. У цій статті ми розглянемо, як використовувати TypeScript разом з Mongoose для визначення типів запитів.

export const getOne = <T extends Document>(Model: Model<T>, popOptions?: string): RequestHandler =>
  catchAsync(async (req: Request<{id: ID}>, res: Response, next: NextFunction) => {
    const query: any = Model.findById(req.params.id)
    if (popOptions) query: errorHere = query.populate(popOptions);
    const doc = await query.exec() as DocType<T> | null;
    res.status(200).json({
      status: 'success',
      data: {
        data: doc
      }
    });
  });

export const getOne = <T extends Document>(Model: Model<T>, popOptions?: string): RequestHandler =>

catchAsync(async (req: Request<{id: ID}>, res: Response, next: NextFunction) => {

const query: any = Model.findById(req.params.id)

if (popOptions) query: errorHere = query.populate(popOptions);

const doc = await query.exec() as DocType<T> | null;

res.status(200).json({

status: 'success',

data: {

data: doc

}

});

У даному прикладі ми створюємо обробник, який отримує модель Mongoose та опції для запиту, і повертає результат запиту до бази даних. Однак, TypeScript не може інферувати типи з властивостей Mongoose запиту напряму, тому ми використовуємо тип any для об’єкта запиту. Це може призвести до втрати перевірки типів та підвищення ризику помилок.

Для вирішення цієї проблеми ми можемо визначити власний тип для об’єкта запиту, що базується на типах Mongoose. Такий підхід дозволяє нам забезпечити правильну перевірку типів та зробити код більш чистим та зрозумілим. Наприклад:

interface CustomQuery<T extends Document> extends Query<T | null, T> {
  populate(path: string): CustomQuery<T>;
}

interface CustomQuery<T extends Document> extends Query<T | null, T> {

populate(path: string): CustomQuery<T>;

}

Після визначення власного типу для об’єкта запиту ми можемо використовувати його замість any у нашому обробнику запиту. Це дозволить нам отримати перевірку типів під час розробки та уникнути потенційних помилок.