Error in Mongoose and TypeScript: Missing property '_doc' on interface 'IEventModel'

Question

Error in Mongoose and TypeScript: Missing property '_doc' on interface 'IEventModel'

Currently, I am enhancing my JavaScript backend programming skills through a comprehensive course that covers ExpressJS, MongoDB, and GraphQL. To make things more challenging, I have decided to reinforce my TypeScript proficiency by completing all the assignments using TypeScript.

At the moment, I am utilizing version 5.5.6 of mongoose and @types/mongoose. Below is the interface I have defined for the type of DB record:

export default interface IEvent {
    _id: any;
    title: string;
    description: string;
    price: number;
    date: string | Date;
}

Subsequently, I crafted the Mongoose Model in the following manner:

import { Document, Schema, model } from 'mongoose';
import IEvent from '../ts-types/Event.type';

export interface IEventModel extends IEvent, Document {}

const eventSchema: Schema = new Schema({
    title: {
        type: String,
        required: true
    },
    description: {
        type: String,
        required: true
    },
    price: {
        type: Number,
        required: true
    },
    date: {
        type: Date,
        required: true
    }
});

export default model<IEventModel>('Event', eventSchema);

Lastly, I have formulated the subsequent resolver for a GraphQL mutation:

createEvent: async (args: ICreateEventArgs): Promise<IEvent> => {
            const { eventInput } = args;
            const event = new EventModel({
                title: eventInput.title,
                description: eventInput.description,
                price: +eventInput.price,
                date: new Date(eventInput.date)
            });
            try {
                const result: IEventModel = await event.save();
                return { ...result._doc };
            } catch (ex) {
                console.log(ex); // tslint:disable-line no-console
                throw ex;
            }
        }

The issue I am encountering is an error in TypeScript stating that "._doc" is not a property on "result". The specific error message reads as follows:

error TS2339: Property '_doc' does not exist on type 'IEventModel'.

I am struggling to identify where I might be going wrong. Despite thoroughly reviewing the documentation, it appears that all the necessary Mongoose properties are included. I may temporarily add the property to my own interface to progress with the course; however, I would greatly appreciate assistance in pinpointing the correct resolution.

mongodb typescript mongoose

Answer 1

Answer №1

Although this response may be tardy, it is intended to assist anyone in need of this information.

interface DocumentOutcome<T> {
    _doc: T;
}

interface IEvent extends DocumentOutcome<IEvent> {
    _id: any;
    title: string;
    description: string;
    price: number;
    date: string | Date;
}

By calling for (...)._doc, you can specify the type of _doc and allow vscode to interpret your designation accurately. Utilizing a generic declaration simplifies things, and rather than creating an interface solely for holding that property, you can integrate it within IEvent using the IEvent type.

Answer 2

Although this response may be tardy, it is intended to assist anyone in need of this information.

interface DocumentOutcome<T> {
    _doc: T;
}

interface IEvent extends DocumentOutcome<IEvent> {
    _id: any;
    title: string;
    description: string;
    price: number;
    date: string | Date;
}

By calling for (...)._doc, you can specify the type of _doc and allow vscode to interpret your designation accurately. Utilizing a generic declaration simplifies things, and rather than creating an interface solely for holding that property, you can integrate it within IEvent using the IEvent type.

Answer 3

Answer №2

When working with typescript and mongoose, I always follow a specific process.

export interface IDummy {
  something: string;
  somethingElse: string;
}

export interface DummyDocument extends IDummy, mongoose.Document {
  createdAt: Date;
  updatedAt: Date;
  _doc?: any
}

First, define interfaces for the schema and model.

const DummySchema = new mongoose.Schema<DummyDocument>({
  something: String,
  somethingElse: String,
})

Next, create the schema.

export const DummyModel = mongoose.model<DummyDocument>

Finally, export the model using the export model pattern. By following this method, you can avoid typescript errors and manually attach the _doc to the model with generics.

Answer 4

When working with typescript and mongoose, I always follow a specific process.

export interface IDummy {
  something: string;
  somethingElse: string;
}

export interface DummyDocument extends IDummy, mongoose.Document {
  createdAt: Date;
  updatedAt: Date;
  _doc?: any
}

First, define interfaces for the schema and model.

const DummySchema = new mongoose.Schema<DummyDocument>({
  something: String,
  somethingElse: String,
})

Next, create the schema.

export const DummyModel = mongoose.model<DummyDocument>

Finally, export the model using the export model pattern. By following this method, you can avoid typescript errors and manually attach the _doc to the model with generics.

Answer 5

Answer №3

interface MongoResult {
  _doc: any
}

export default interface IEvent extends MongoResult {
    _id: any;
    title: string;
    description: string;
    price: number;
    date: string | Date;
}

Next, you will need to handle converting the _doc back to your custom IEvent object...

Answer 6

interface MongoResult {
  _doc: any
}

export default interface IEvent extends MongoResult {
    _id: any;
    title: string;
    description: string;
    price: number;
    date: string | Date;
}

Next, you will need to handle converting the _doc back to your custom IEvent object...

Answer 7

Answer №4

Insert a _doc field of type any into your personalized Model interface

interface IUser extends Document {
 ...
 _doc: any
}

You can find a comprehensive example at this link https://github.com/apotox/express-mongoose-typescript-starter

Answer 8

Insert a _doc field of type any into your personalized Model interface

interface IUser extends Document {
 ...
 _doc: any
}

You can find a comprehensive example at this link https://github.com/apotox/express-mongoose-typescript-starter

Answer 9

Answer №5

In dealing with the circular reference issue related to the _doc field, a straightforward approach is to utilize the following method. This technique effectively prevents infinite circular references by excluding itself within the child record. Furthermore, no interface extension is necessary!

export default interface IEvent {
    _doc: Omit<this,'_doc'>;
}

Answer 10

In dealing with the circular reference issue related to the _doc field, a straightforward approach is to utilize the following method. This technique effectively prevents infinite circular references by excluding itself within the child record. Furthermore, no interface extension is necessary!

export default interface IEvent {
    _doc: Omit<this,'_doc'>;
}

Answer 11

Answer №6

There seems to be an issue with the return type structure missing from the @types/mongoose library. This results in errors when trying to de-structure the return object because the variable is not defined in the interface signature of both document and custom types. It appears to be a bug that needs to be addressed.

To work around this issue, simply return the result itself. This will automatically return the data defined in the interface (IEvent) without including any meta data.


try {
    const result = await event.save();
                return result;
            } catch (ex) {
                throw ex;
            }

Answer 12

There seems to be an issue with the return type structure missing from the @types/mongoose library. This results in errors when trying to de-structure the return object because the variable is not defined in the interface signature of both document and custom types. It appears to be a bug that needs to be addressed.

To work around this issue, simply return the result itself. This will automatically return the data defined in the interface (IEvent) without including any meta data.


try {
    const result = await event.save();
                return result;
            } catch (ex) {
                throw ex;
            }

Error in Mongoose and TypeScript: Missing property '_doc' on interface 'IEventModel'

Answer №1

Answer №2

Answer №3

Answer №4

Answer №5

Answer №6

Similar questions

Creating variables in Typescript

Error: The property 'inputItem' is not recognized on type 'EventTarget' - Utilizing Semantic-Ui, React, and Typescript

I am experiencing slow load times for my Angular 2 app when first-time users access it, and I am seeking assistance in optimizing its speed

Asking for something with no discernible purpose

What is the best way to query based on a nested object property in Mongoose?

Searching for data with the Mongoose find() method in a NodeJs bot

Is there a way to transform a string property into a custom type in a TypeScript array?

Using Express to insert data into a MongoDB database

Create an object that may have any number of keys, but must have at least one key defined

searching for data within nested documents with Morphia

Concocting your custom blob in Angular 2 from input may lead to data corruption

State hook variable not being properly updated within a functional component

Storing and accessing formatted text in MongoDB: A comprehensive guide

Recursive function used to update an array of objects by dynamically mapping replies to comments

Save pictures on the server as files or store them in the database as a byte array

Tips for locating a file based on an embedded element using MongoDB with PHP

Issues with the performance of a Node.js and MongoDB application hosted on AWS

What is the process for updating a value on a client site with mongodb?

Removing a string from an array in Node.js using Mongoose's pull method

Rollup's watch/build feature is slow to catch up with a single change made