mongoose icon indicating copy to clipboard operation
mongoose copied to clipboard

Document does not type non-default timestamp property names

Open maxmwang opened this issue 1 year ago • 2 comments

Prerequisites

  • [x] I have written a descriptive issue title
  • [X] I have searched existing issues to ensure the bug has not already been reported

Mongoose version

6.8.0, 7.0.3

Node.js version

16.17.0

MongoDB server version

5.0.14

Typescript version (if applicable)

4.8.4

Description

Builds on earlier issue #12069 where Document and InferSchemaType does not infer timestamp fields into Typescript types.

Renamed timestamp fields are not extracted using Document and InferSchemaType.

Steps to Reproduce

import { Schema, InferSchemaType, Document } from 'mongoose';

const MySchema = new Schema({ 
  username: String,
}, {
  timestamps: {
    createdAt: "date_joined",
    updatedAt: false,
  },
});

export type MyType = Document & InferSchemaType<typeof MySchema>;

Expected Behavior

We expect MyType to be:

type MyType = {
  username: String,
  date_joined: Date,
};

We get:

type MyType = {
  username: String,
};
Screen Shot 2023-03-26 at 12 58 09 AM

Note how not even createdAt is on the type. Looking at the actual Document, we will see a type that looks like our expected type (with username, date_joined, and no updatedAt field).

maxmwang avatar Mar 26 '23 07:03 maxmwang

We'll add support for this in the future. But, in the meantime, I recommend you add date_joined to your schema manually as follows.


const MySchema = new Schema({ 
  username: String,
  date_joined: Date,
}, {
  timestamps: {
    createdAt: "date_joined",
    updatedAt: false,
  },
});

vkarpov15 avatar Mar 28 '23 14:03 vkarpov15

The way I added my timestamps is as follows:

const MySchema = new Schema({ username: String, date_joined: Date, }, { timestamps: true });

donoftime2018 avatar Nov 02 '23 02:11 donoftime2018