Function autoInferredWithCustomVersionKey

test/types/document.test.ts:710–745

()

  }

  function autoInferredWithCustomVersionKey() {
    interface RawDocType {
      _id: Types.ObjectId;
      testProperty?: number | null;
    }

    const ASchema = new Schema({
      testProperty: Number
    }, { versionKey: 'taco' });

    const AModel = model('YourModel', ASchema);

    type TSchemaOptions = ResolveSchemaOptions<ObtainSchemaGeneric<typeof ASchema, 'TSchemaOptions'>>;

    const a = new AModel({ testProperty: 8 });
    const toObjectFlattened: Omit<RawDocType, '_id'> & { _id: string } = a.toObject({ flattenObjectIds: true });
    const toObjectWithVirtuals: Omit<RawDocType, '_id'> & { _id: string } = a.toObject({ virtuals: true, flattenObjectIds: true });
    const toObjectWithoutVirtuals: Omit<RawDocType, '_id'> & { _id: string } = a.toObject({ virtuals: false, flattenObjectIds: true });
    const toJSONFlattened: Omit<RawDocType, '_id'> & { _id: string } = a.toJSON({ flattenObjectIds: true });
    const toJSONWithVirtuals: Omit<RawDocType, '_id'> & { _id: string } = a.toJSON({ virtuals: true, flattenObjectIds: true });
    const toJSONWithoutVirtuals: Omit<RawDocType, '_id'> & { _id: string } = a.toJSON({ virtuals: false, flattenObjectIds: true });

    // When passing options, custom version key should still be present
    expect(a.toObject({ flattenObjectIds: true }).taco).type.toBe<number>();
    expect(a.toJSON({ flattenObjectIds: true }).taco).type.toBe<number>();

    const objWithoutVersionKey = a.toObject({ versionKey: false });
    const jsonWithoutVersionKey = a.toJSON({ versionKey: false });
    expect(objWithoutVersionKey).type.not.toHaveProperty('__v');
    expect(jsonWithoutVersionKey).type.not.toHaveProperty('__v');

    const objWithVersionKey = a.toObject();
    const jsonWithVersionKey = a.toJSON();
    expect(objWithVersionKey.taco).type.toBe<number>();
    expect(jsonWithVersionKey.taco).type.toBe<number>();
  }
}

async function gh15594() {