[json-stable-stringify] fix: add type for optional Comparator argument

[dal-liu]

Please fill in this template.

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

Select one of these and delete the others:

If changing an existing definition:

• [x] Provide a URL to documentation or source code which provides context for the suggested changes: link to docs
• [x] If this PR brings the type definitions up to date with a new version of the JS library, update the version number in the package.json.

[typescript-bot]

@dal-liu Thank you for submitting this PR!

This is a live comment that I will keep updated.

1 package in this PR

• json-stable-stringify — on npm, on unpkg
  • owner-approval: @mhfrantz

Code Reviews

Because this is a widely-used package, a DT maintainer will need to review it before it can be merged.

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

Status

• ✅ No merge conflicts
• ✅ Continuous integration tests have passed
• ✅ Most recent commit is approved by a DT maintainer

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": 70956,
  "author": "dal-liu",
  "headCommitOid": "ed23bea9279a10776dea596392e7e350c7305b34",
  "mergeBaseOid": "f8f3ac929e9d8a6e21dee18889aa5be93b27f200",
  "lastPushDate": "2024-10-19T18:08:09.000Z",
  "lastActivityDate": "2024-10-24T15:32:30.000Z",
  "mergeOfferDate": "2024-10-24T14:19:56.000Z",
  "mergeRequestDate": "2024-10-24T15:32:30.000Z",
  "mergeRequestUser": "dal-liu",
  "hasMergeConflict": false,
  "isFirstContribution": false,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Critical",
  "pkgInfo": [
    {
      "name": "json-stable-stringify",
      "kind": "edit",
      "files": [
        {
          "path": "types/json-stable-stringify/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/json-stable-stringify/json-stable-stringify-tests.ts",
          "kind": "test"
        },
        {
          "path": "types/json-stable-stringify/package.json",
          "kind": "package-meta-ok"
        }
      ],
      "owners": [
        "mhfrantz"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Critical"
    }
  ],
  "reviews": [
    {
      "type": "approved",
      "reviewer": "sandersn",
      "date": "2024-10-24T14:19:18.000Z",
      "isMaintainer": true
    },
    {
      "type": "approved",
      "reviewer": "mhfrantz",
      "date": "2024-10-21T14:47:07.000Z",
      "isMaintainer": false
    }
  ],
  "mainBotCommentID": 2424113448,
  "ciResult": "pass"
}

[typescript-bot]

🔔 @mhfrantz — 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.

[typescript-bot]

@dal-liu: Everything looks good here. I am ready to merge this PR (at ed23bea) on your behalf whenever you think it's ready.

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! :heart:

(@mhfrantz: you can do this too.)

[dal-liu]

Ready to merge