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

Fix types for dash for node-media-server #62491

Conversation

princefishthrower
Copy link
Contributor

@princefishthrower princefishthrower commented Sep 30, 2022

For node-media-server

Please fill in this template.

Select one of these and delete the others:

If adding a new definition:

  • The package does not already provide its own types, or cannot have its .d.ts files generated via --declaration
  • If this is for an npm package, match the name. If not, do not conflict with the name of an npm package.
  • Create it with dts-gen --dt, not by basing it on an existing project.
  • Represents shape of module/library correctly
  • tslint.json should contain { "extends": "@definitelytyped/dtslint/dt.json" }, and no additional rules.
  • tsconfig.json should have noImplicitAny, noImplicitThis, strictNullChecks, and strictFunctionTypes set to true.

If changing an existing definition:

  • Provide a URL to documentation or source code which provides context for the suggested changes: https://github.com/illuspas/Node-Media-Server
  • 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.

If removing a declaration:

  • If a package was never on Definitely Typed, you don't need to do anything. (If you wrote a package and provided types, you don't need to register it with us.)
  • Delete the package's directory.
  • Add it to notNeededPackages.json.

For node-media-server
@typescript-bot
Copy link
Contributor

typescript-bot commented Sep 30, 2022

@princefishthrower Thank you for submitting this PR!

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

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": 62491,
  "author": "princefishthrower",
  "headCommitOid": "6706202474bca0014bcb2a455aea26293133e00b",
  "mergeBaseOid": "727bae0d5bc67bf017ff9746bb12c2a6a6eb8afa",
  "lastPushDate": "2022-10-02T21:11:27.000Z",
  "lastActivityDate": "2022-10-14T06:42:04.000Z",
  "mergeOfferDate": "2022-10-14T06:41:56.000Z",
  "mergeRequestDate": "2022-10-14T06:42:04.000Z",
  "mergeRequestUser": "Tseberechts",
  "hasMergeConflict": false,
  "isFirstContribution": false,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Well-liked by everyone",
  "pkgInfo": [
    {
      "name": "node-media-server",
      "kind": "edit",
      "files": [
        {
          "path": "types/node-media-server/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/node-media-server/node-media-server-tests.ts",
          "kind": "test"
        }
      ],
      "owners": [
        "Tseberechts"
      ],
      "addedOwners": [
        "princefishthrower"
      ],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    }
  ],
  "reviews": [
    {
      "type": "approved",
      "reviewer": "Tseberechts",
      "date": "2022-10-14T06:41:07.000Z",
      "isMaintainer": false
    }
  ],
  "mainBotCommentID": 1264043999,
  "ciResult": "pass"
}

@typescript-bot typescript-bot added Edits Owners This PR adds or removes owners Untested Change This PR does not touch tests labels Sep 30, 2022
@typescript-bot typescript-bot added this to Waiting for Code Reviews in New Pull Request Status Board Sep 30, 2022
@typescript-bot
Copy link
Contributor

🔔 @Tseberechts — 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 moved this from Waiting for Code Reviews to Needs Maintainer Review in New Pull Request Status Board Sep 30, 2022
@princefishthrower
Copy link
Contributor Author

princefishthrower commented Sep 30, 2022

This pull request should resolve the issue raised in #62485 However, I'm not an expert with the node-media-server library and therefore I'm not sure that dash should be boolean. (Though if it should strictly be set to true then it is likely this "parameter" should be refactored to a const or similar within the library) Input / validation from @Tseberechts , the original creator of the typings, would be helpful!

EDIT: I dug into the source a little bit, it seems it's used at least to check if it is true: https://github.com/illuspas/Node-Media-Server/blob/97ca3c8f28f9c8579b509559ffb548d545c400a7/src/node_trans_session.js#L59 I think it anyway overall makes more sense / is a more normal pattern for this small fix to type it as boolean

@typescript-bot typescript-bot removed the Untested Change This PR does not touch tests label Oct 2, 2022
@typescript-bot typescript-bot moved this from Needs Maintainer Review to Waiting for Code Reviews in New Pull Request Status Board Oct 2, 2022
@typescript-bot typescript-bot added the Unreviewed No one showed up to review this PR, so it'll be reviewed by a DT maintainer. label Oct 14, 2022
@typescript-bot
Copy link
Contributor

Re-ping @Tseberechts:

This PR has been out for over a week, yet I haven't seen any reviews.

Could someone please give it some attention? Thanks!

@typescript-bot typescript-bot added Owner Approved A listed owner of this package signed off on the pull request. Self Merge This PR can now be self-merged by the PR author or an owner and removed Unreviewed No one showed up to review this PR, so it'll be reviewed by a DT maintainer. labels Oct 14, 2022
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Waiting for Author to Merge in New Pull Request Status Board Oct 14, 2022
@typescript-bot
Copy link
Contributor

@princefishthrower: Everything looks good here. I am ready to merge this PR (at 6706202) 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! ❤️

(@Tseberechts: you can do this too.)

@Tseberechts
Copy link
Contributor

Ready to merge

@typescript-bot typescript-bot moved this from Waiting for Author to Merge to Recently Merged in New Pull Request Status Board Oct 14, 2022
@typescript-bot typescript-bot merged commit 3db63d6 into DefinitelyTyped:master Oct 14, 2022
@typescript-bot typescript-bot removed this from Recently Merged in New Pull Request Status Board Feb 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Edits Owners This PR adds or removes owners Owner Approved A listed owner of this package signed off on the pull request. Self Merge This PR can now be self-merged by the PR author or an owner
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants