Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ts: strictly typed query cursor async iterator #10253

Merged

Conversation

borfig
Copy link
Contributor

@borfig borfig commented May 15, 2021

Closes #10252

Thanks for submitting a pull request! Please provide enough information so that others can review your pull request. The two fields below are mandatory.

If you're making a change to documentation, do not modify a .html file directly. Instead find the corresponding .pug file or test case in the test/docs directory.

Summary

This PR implements #10252

Examples

Currently, the following TypeScript code compiles, with the bug in the code:

import { Schema, model } from "mongoose";
interface Test {
  test: string;
}
const schema = new Schema<Test>({
  test: { type: String, required: true },
});
const TestModel = model<Test>("Test", schema);
async function main() {
  const cursor = TestModel.find({}).cursor();
  for await (const test of cursor) {
    console.log(test.tedt); // intentional bug
  }
}
main()

The proposed change makes the above not compile

Copy link
Collaborator

@vkarpov15 vkarpov15 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks 👍

@vkarpov15 vkarpov15 added this to the 5.12.10 milestone May 16, 2021
@vkarpov15 vkarpov15 merged commit a7290de into Automattic:master May 16, 2021
@vkarpov15 vkarpov15 added the typescript Types or Types-test related issue / Pull Request label May 16, 2021
@borfig borfig deleted the improve-query-cursor-typing branch May 17, 2021 17:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
typescript Types or Types-test related issue / Pull Request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Strictly typed Query Cursor async iterator
2 participants