mongodb: Add returnDocument and deprecate returnOriginal

[djdmbrwsk]

Please fill in this template.

• Use a meaningful title for the pull request. Include the name of the package modified.
• Test the change in your own code. (Compile and run.)
• Add or edit tests to reflect the change.
• Follow the advice from the readme.
• Avoid common mistakes.
• Run npm test <package to test>.

Select one of these and delete the others:

If changing an existing definition:

• Provide a URL to documentation or source code which provides context for the suggested changes: refactor(NODE-1812): Deprecate returnOriginal in favor of returnDocument mongodb/node-mongodb-native#2808
• If this PR brings the type definitions up to date with a new version of the JS library, update the version number in the header.

This PR adds a definition for the new returnDocument option used in findOneAndReplace() and findOneAndUpdate(). It also marks returnOriginal with a deprecated comment. CC mongodb/node-mongodb-native#2808

[typescript-bot]

Hey @djdmbrwsk,

😒 Your PR doesn't modify any tests, so it's hard to know what's being fixed, and your changes might regress in the future. Please consider adding tests to cover the change you're making. Including tests allows this PR to be merged by yourself and the owners of this module.

This can potentially save days of time for you!

[typescript-bot]

@djdmbrwsk Thank you for submitting this PR! I see this is your first time submitting to DefinitelyTyped 👋 — I'm the local bot who will help you through the process of getting things through.

This is a live comment which I will keep updated.

1 package in this PR

• mongodb — on npm, on unpkg
  • owner-approval: @LinusU

Code Reviews

This PR can be merged once it's reviewed.

You can test the changes in this PR in the Playground.

Status

• ✅ No merge conflicts
• ✅ Continuous integration tests have passed
• ✅ Most recent commit is approved by type definition owners or DT maintainers

All of the items on the list are green. To merge, you need to post a comment including the string "Ready to merge" to bring in your changes.

---

Diagnostic Information: What the bot saw about this PR

{
  "type": "info",
  "now": "-",
  "pr_number": 53124,
  "author": "djdmbrwsk",
  "headCommitOid": "d4a4ef50a78acec8a6a0c823c77e695c7cce32f5",
  "lastPushDate": "2021-05-20T12:33:03.000Z",
  "lastActivityDate": "2021-05-21T16:13:01.000Z",
  "maintainerBlessed": "Waiting for Code Reviews",
  "mergeOfferDate": "2021-05-20T20:23:53.000Z",
  "mergeRequestDate": "2021-05-21T16:13:01.000Z",
  "mergeRequestUser": "djdmbrwsk",
  "hasMergeConflict": false,
  "isFirstContribution": true,
  "tooManyFiles": false,
  "popularityLevel": "Critical",
  "pkgInfo": [
    {
      "name": "mongodb",
      "kind": "edit",
      "files": [
        {
          "path": "types/mongodb/index.d.ts",
          "kind": "definition"
        }
      ],
      "owners": [
        "CaselIT",
        "alanmarcell",
        "dante-101",
        "mcortesi",
        "EnricoPicci",
        "AJCStriker",
        "julien-c",
        "daprahamian",
        "denys-bushulyak",
        "b4nst",
        "sindbach",
        "geraldinelemeur",
        "various89",
        "angela-1",
        "hector7",
        "floric",
        "erikc5000",
        "Manc",
        "jloveridge",
        "ranguna",
        "HosseinAgha",
        "albertossilva",
        "peterblazejewicz",
        "LinusU",
        "taxilian",
        "xamgore",
        "avaly",
        "HitkoDev",
        "Celend",
        "jtassin",
        "addaleax",
        "emmanuelgautier",
        "wyattjoh"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Critical"
    }
  ],
  "reviews": [
    {
      "type": "approved",
      "reviewer": "LinusU",
      "date": "2021-05-20T15:00:16.000Z",
      "isMaintainer": false
    },
    {
      "type": "approved",
      "reviewer": "almeidx",
      "date": "2021-05-20T14:49:02.000Z",
      "isMaintainer": false
    }
  ],
  "mainBotCommentID": 845120536,
  "ciResult": "pass"
}

[typescript-bot]

🔔 @CaselIT @alanmarcell @Dante-101 @mcortesi @EnricoPicci @AJCStriker @julien-c @daprahamian @Denys-Bushulyak @b4nst @sindbach @geraldinelemeur @various89 @angela-1 @hector7 @floric @erikc5000 @Manc @jloveridge @Ranguna @HosseinAgha @albertossilva @peterblazejewicz @LinusU @taxilian @xamgore @avaly @HitkoDev @Celend @jtassin @addaleax @emmanuelgautier @wyattjoh — please review this PR in the next few days. Be sure to explicitly select Approve or Request Changes in the GitHub UI so I know what's going on.

[LinusU]

👍

[typescript-bot]

@djdmbrwsk Everything looks good here. Great job! I am ready to merge this PR (at d4a4ef5) on your behalf.

If you'd like that to happen, please post a comment saying:

Ready to merge

and I'll merge this PR almost instantly. Thanks for helping out! ❤️

(@CaselIT, @alanmarcell, @Dante-101, @mcortesi, @EnricoPicci, @AJCStriker, @julien-c, @daprahamian, @Denys-Bushulyak, @b4nst, @sindbach, @geraldinelemeur, @various89, @angela-1, @hector7, @floric, @erikc5000, @Manc, @jloveridge, @Ranguna, @HosseinAgha, @albertossilva, @peterblazejewicz, @LinusU, @taxilian, @xamgore, @avaly, @HitkoDev, @Celend, @jtassin, @addaleax, @emmanuelgautier, @wyattjoh: you can do this too.)

[djdmbrwsk]

Ready to merge

[typescript-bot]

I just published @types/mongodb@3.6.16 to npm.