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

updated transformHeader function input type #46197

Closed

Conversation

jbcam
Copy link
Contributor

@jbcam jbcam commented Jul 20, 2020

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. (Run with npm test.)
  • Follow the advice from the readme.
  • Avoid common mistakes.
  • Run npm run lint package-name (or tsc if no tslint.json is present).

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: <Add index argument to "transformHeader" config function mholt/PapaParse#807>
  • 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.
  • Include tests for your changes
  • If you are making substantial changes, consider adding a tslint.json containing { "extends": "dtslint/dt.json" }. If for reason the any rule need to be disabled, disable it for that line using // tslint:disable-next-line [ruleName] and not for whole package so that the need for disabling can be reviewed.

@jbcam jbcam requested a review from johnnyreilly as a code owner July 20, 2020 11:33
@typescript-bot typescript-bot added Where is GH Actions? GH Actions didn't give a response to this PR Popular package This PR affects a popular package (as counted by NPM download counts). labels Jul 20, 2020
@typescript-bot
Copy link
Contributor

typescript-bot commented Jul 20, 2020

@jbcam 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.

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.

Status

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

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


Diagnostic Information: What the bot saw about this PR
{
  "type": "info",
  "now": "-",
  "pr_number": 46197,
  "author": "jbcam",
  "owners": [
    "torpedro",
    "rainshen49",
    "jfloff",
    "johnnyreilly",
    "albertorestifo",
    "BehindTheMath",
    "3af",
    "jliuhtonen",
    "rbarbazz"
  ],
  "dangerLevel": "ScopedAndTested",
  "headCommitAbbrOid": "57db620",
  "headCommitOid": "57db620947be0e68a77632ca098e496c682d835a",
  "mergeIsRequested": false,
  "stalenessInDays": 0,
  "lastPushDate": "2020-07-20T11:24:47.000Z",
  "lastCommentDate": "2020-07-20T11:36:33.000Z",
  "maintainerBlessed": false,
  "reviewLink": "https://github.com/DefinitelyTyped/DefinitelyTyped/pull/46197/files",
  "hasMergeConflict": false,
  "authorIsOwner": false,
  "isFirstContribution": true,
  "popularityLevel": "Popular",
  "anyPackageIsNew": false,
  "packages": [
    "papaparse"
  ],
  "files": [
    {
      "path": "types/papaparse/index.d.ts",
      "kind": "definition",
      "package": "papaparse"
    },
    {
      "path": "types/papaparse/papaparse-tests.ts",
      "kind": "test",
      "package": "papaparse"
    }
  ],
  "hasDismissedReview": false,
  "ciResult": "pass",
  "reviewersWithStaleReviews": [],
  "approvalFlags": 0,
  "isChangesRequested": false
}

@typescript-bot
Copy link
Contributor

🔔 @torpedro @rainshen49 @jfloff @johnnyreilly @albertorestifo @BehindTheMath @3af @jliuhtonen @rbarbazz — 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.

transform: function(value, field) {},
transformHeader: function(header) {
transform: function (value, field) {},
transformHeader: function (header, index) {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

actual change is located here, everything else is linter update

@typescript-bot typescript-bot removed the Where is GH Actions? GH Actions didn't give a response to this PR label Jul 20, 2020
@typescript-bot typescript-bot moved this from Other to Waiting for Code Reviews in New Pull Request Status Board Jul 20, 2020
@danger-public
Copy link

Inspecting the JavaScript source for this package found some properties that are not in the .d.ts files.
The check for missing properties isn't always right, so take this list as advice, not a requirement.

papaparse (unpkg)

was missing the following properties:

  1. BYTE_ORDER_MARK
  2. BAD_DELIMITERS
  3. ParserHandle
  4. NetworkStreamer
  5. FileStreamer
as well as these 3 other properties...

StringStreamer, ReadableStreamStreamer, DuplexStreamStreamer

Generated by 🚫 dangerJS against 57db620

@jbcam jbcam closed this Jul 20, 2020
@jbcam jbcam force-pushed the update-transformHeader-type branch from 57db620 to 8c9eba5 Compare July 20, 2020 11:37
@typescript-bot typescript-bot added Mergebot Error Mergebot encountered errors when processing this PR and removed Popular package This PR affects a popular package (as counted by NPM download counts). labels Jul 20, 2020
@typescript-bot
Copy link
Contributor

@jbcam — There was an error that prevented me from properly processing this PR:

No head commit found

@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Other in New Pull Request Status Board Jul 20, 2020
@typescript-bot
Copy link
Contributor

👋 Hi there! I’ve run some quick measurements against master and your PR. These metrics should help the humans reviewing this PR gauge whether it might negatively affect compile times or editor responsiveness for users who install these typings.

Let’s review the numbers, shall we?

Comparison details 📊
master #46197 diff
Batch compilation
Memory usage (MiB) 98.9 101.4 +2.5%
Type count 15331 15331 0%
Assignability cache size 3696 3696 0%
Language service
Samples taken 164 165 +1%
Identifiers in tests 164 165 +1%
getCompletionsAtPosition
    Mean duration (ms) 537.4 545.8 +1.6%
    Mean CV 8.1% 10.4%
    Worst duration (ms) 650.7 628.9 -3.4%
    Worst identifier Papa Papa
getQuickInfoAtPosition
    Mean duration (ms) 566.6 548.4 -3.2%
    Mean CV 10.5% 10.7% +2.0%
    Worst duration (ms) 702.2 651.8 -7.2%
    Worst identifier Papa unparse

It looks like nothing changed too much. I won’t post performance data again unless it gets worse.

@typescript-bot typescript-bot added the Perf: Same typescript-bot determined that this PR will not significantly impact compilation performance. label Jul 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Mergebot Error Mergebot encountered errors when processing this PR Perf: Same typescript-bot determined that this PR will not significantly impact compilation performance.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants