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

[globaloffensive] Add alternative signature for inspectItem method #69634

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

xxzefgh
Copy link

@xxzefgh xxzefgh commented May 17, 2024

Please fill in this template.

If changing an existing definition:

Signed-off-by: Mirza Brunjadze <brunjadzem@gmail.com>
@typescript-bot
Copy link
Contributor

typescript-bot commented May 17, 2024

@xxzefgh 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

Code Reviews

Because you edited one package and updated the tests (👏), I can help you merge this PR once someone else signs off on it.

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 type definition owners, DT maintainers or others

Once every item on this list is checked, I'll ask you for permission to merge and publish the changes.

Inactive

This PR has been inactive for 8 days.


Diagnostic Information: What the bot saw about this PR
{
  "type": "info",
  "now": "-",
  "pr_number": 69634,
  "author": "xxzefgh",
  "headCommitOid": "a34219ff7752506a6b8e148608178ab047cca42b",
  "mergeBaseOid": "2352fc29c1e4e51e0ca9190ced3d4ef36e204cd1",
  "lastPushDate": "2024-05-17T22:37:10.000Z",
  "lastActivityDate": "2024-05-24T10:56:23.000Z",
  "hasMergeConflict": false,
  "isFirstContribution": true,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Well-liked by everyone",
  "pkgInfo": [
    {
      "name": "globaloffensive",
      "kind": "edit",
      "files": [
        {
          "path": "types/globaloffensive/globaloffensive-tests.ts",
          "kind": "test"
        },
        {
          "path": "types/globaloffensive/index.d.ts",
          "kind": "definition"
        }
      ],
      "owners": [
        "joshuajeschek"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    }
  ],
  "reviews": [
    {
      "type": "changereq",
      "reviewer": "joshuajeschek",
      "date": "2024-05-24T10:56:23.000Z"
    }
  ],
  "mainBotCommentID": 2118457050,
  "ciResult": "pass"
}

@typescript-bot
Copy link
Contributor

🔔 @joshuajeschek — 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 typescript-bot added this to Waiting for Code Reviews in New Pull Request Status Board May 17, 2024
Copy link
Contributor

@joshuajeschek joshuajeschek left a comment

Choose a reason for hiding this comment

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

Thanks for finding this feature, didn't know it existed as it wasn't present in the documentation 👍🏼

@@ -92,6 +92,10 @@ declare class GlobalOffensive extends EventEmitter {
d?: string,
callback?: (item: GlobalOffensive.ItemInfo) => void,
): void;
inspectItem(
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
inspectItem(
/**
* Sends the same request to the GC that the official client sends when you inspect an item.
* If all parameters are correct and the GC is in a good mood, returns the item's data.
* Using this for an item your account owns is useless as all the data is already available in `inventory`.
*
* The response will arrive in the callback and in the `inspectItemInfo` event.
*
* As of v2.1.0, the request will time out if no response is received in 10 seconds.
* If this happens, `inspectItemTimedOut` will be emitted.
*
* @param owner The numeric SteamID or market listing ID of the owning Steam account or market listing,
* as a string; or an entire inspect link.
* @param callback Called if all parameters are valid when Steam responds to us.
*
* @since v1.1
*/
inspectItem(

Let's add the adjusted documentation for this overload as well :)

@typescript-bot typescript-bot added the Revision needed This PR needs code changes before it can be merged. label May 24, 2024
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Author Action in New Pull Request Status Board May 24, 2024
@typescript-bot
Copy link
Contributor

@xxzefgh One or more reviewers has requested changes. Please address their comments. I'll be back once they sign off or you've pushed new commits. Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Revision needed This PR needs code changes before it can be merged.
Projects
Development

Successfully merging this pull request may close these issues.

None yet

3 participants