feat: support `BigUint64Array`, `BigInt64Array`, and `GenericArray` by manzt · Pull Request #56163 · DefinitelyTyped/DefinitelyTyped

manzt · 2021-10-03T22:04:00Z

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: https://github.com/scijs/ndarray#arraydtype
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.

ndarray supports BigInt64 and BigUint64 data (see link above). This PR adds support for these typed arrays but preserves the default the top-level signature ndarray.Ndarray when the type parameters of Data aren't defined.

typescript-bot · 2021-10-03T22:04:35Z

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

2 packages in this PR

ndarray — on npm, on unpkg
- owner-approval: @axelboc
numjs — on npm, on unpkg

Code Reviews

Because this PR edits multiple packages, it can be merged once it's reviewed by a DT maintainer.

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

Status

✅ No merge conflicts
✅ Continuous integration tests have passed
✅ A DT maintainer needs to approve changes which affect more than one package

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": 56163,
  "author": "manzt",
  "headCommitOid": "878b2a71ecf88689abb04856adb75a420c864c96",
  "lastPushDate": "2021-10-20T14:19:32.000Z",
  "lastActivityDate": "2021-10-28T10:39:13.000Z",
  "mergeOfferDate": "2021-10-28T08:25:42.000Z",
  "mergeRequestDate": "2021-10-28T10:39:13.000Z",
  "mergeRequestUser": "manzt",
  "hasMergeConflict": false,
  "isFirstContribution": true,
  "tooManyFiles": false,
  "popularityLevel": "Well-liked by everyone",
  "pkgInfo": [
    {
      "name": "ndarray",
      "kind": "edit",
      "files": [
        {
          "path": "types/ndarray/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/ndarray/ndarray-tests.ts",
          "kind": "test"
        }
      ],
      "owners": [
        "pawsong",
        "taoqf",
        "axelboc"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    },
    {
      "name": "numjs",
      "kind": "edit",
      "files": [
        {
          "path": "types/numjs/numjs-tests.ts",
          "kind": "test"
        }
      ],
      "owners": [
        "taoqf",
        "mattmm3d"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    }
  ],
  "reviews": [
    {
      "type": "approved",
      "reviewer": "orta",
      "date": "2021-10-28T08:25:06.000Z",
      "isMaintainer": true
    },
    {
      "type": "approved",
      "reviewer": "axelboc",
      "date": "2021-10-21T13:09:03.000Z",
      "isMaintainer": false
    },
    {
      "type": "stale",
      "reviewer": "rbuckton",
      "date": "2021-10-19T22:11:51.000Z",
      "abbrOid": "5333643"
    }
  ],
  "mainBotCommentID": 933032741,
  "ciResult": "pass"
}

typescript-bot · 2021-10-03T22:04:37Z

🔔 @pawsong @taoqf @axelboc @mattmm3d — 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 · 2021-10-03T22:09:56Z

@manzt The CI build failed! Please review the logs for more information.

Once you've pushed the fixes, the build will automatically re-run. Thanks!

Note: builds which are failing do not end up on the list of PRs for the DT maintainers to review.

typescript-bot · 2021-10-03T23:01:35Z

@manzt The CI build failed! Please review the logs for more information.

Once you've pushed the fixes, the build will automatically re-run. Thanks!

Note: builds which are failing do not end up on the list of PRs for the DT maintainers to review.

typescript-bot · 2021-10-03T23:23:01Z

@manzt The CI build failed! Please review the logs for more information.

Once you've pushed the fixes, the build will automatically re-run. Thanks!

Note: builds which are failing do not end up on the list of PRs for the DT maintainers to review.

axelboc · 2021-10-04T06:54:24Z

 //                 Axel Bocciarelli <https://github.com/axelboc>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 // TypeScript Version: 2.3
+/// <reference lib="esnext.bigint" />


Ah nice, I was wondering how to make bigint work without impacting projects without esnext.bigint 💯

This isn't the correct way to handle this. By adding a lib reference, you cause every compilation that depends on your package to assume that BigInt64Array is available. A lib reference should only be added for types provided from a host or runtime (such as NodeJS), or from a polyfill/shim library that adds the functionality.

If you want to depend on a "possibly available" BigInt64Array, you can do something like this instead:

type MaybeBigInt64Array = InstanceType<typeof globalThis extends { BigInt64Array: infer T } ? T : never>; type MaybeBigUint64Array = InstanceType<typeof globalThis extends { BigUint64Array: infer T } ? T : never>;

This conditionally gets the type for BigInt64Array and BigUint64Array based on the user's settings. If they are not present, then the types are never (and are thus removed from unions), but if they are present you get the correct type.

typescript-bot · 2021-10-04T07:01:41Z

@manzt 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!

axelboc

Awesome! 🚀

typescript-bot · 2021-10-06T17:08:12Z

@axelboc Thank you for reviewing this PR! The author has pushed new commits since your last review. Could you take another look and submit a fresh review?

typescript-bot · 2021-10-07T14:00:04Z

@axelboc Thank you for reviewing this PR! The author has pushed new commits since your last review. Could you take another look and submit a fresh review?

typescript-bot · 2021-10-18T18:58:37Z

Re-ping @pawsong, @taoqf, @mattmm3d:

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

Could someone please give it some attention? Thanks!

rbuckton · 2021-10-19T22:10:24Z

 //                 Axel Bocciarelli <https://github.com/axelboc>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 // TypeScript Version: 2.3
+/// <reference lib="esnext.bigint" />


This isn't the correct way to handle this. By adding a lib reference, you cause every compilation that depends on your package to assume that BigInt64Array is available. A lib reference should only be added for types provided from a host or runtime (such as NodeJS), or from a polyfill/shim library that adds the functionality.

If you want to depend on a "possibly available" BigInt64Array, you can do something like this instead:

type MaybeBigInt64Array = InstanceType<typeof globalThis extends { BigInt64Array: infer T } ? T : never>; type MaybeBigUint64Array = InstanceType<typeof globalThis extends { BigUint64Array: infer T } ? T : never>;

This conditionally gets the type for BigInt64Array and BigUint64Array based on the user's settings. If they are not present, then the types are never (and are thus removed from unions), but if they are present you get the correct type.

typescript-bot · 2021-10-19T22:12:29Z

@manzt 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!

manzt · 2021-10-20T14:21:02Z

@rbuckton -- thank you for the suggestion. I was not aware of the correct way to conditionally include these types. Fixed.

typescript-bot · 2021-10-20T14:26:20Z

@rbuckton, @axelboc Thank you for reviewing this PR! The author has pushed new commits since your last review. Could you take another look and submit a fresh review?

typescript-bot · 2021-10-21T13:09:39Z

@rbuckton Thank you for reviewing this PR! The author has pushed new commits since your last review. Could you take another look and submit a fresh review?

orta

Agree, these changes look good now 👍🏻

typescript-bot · 2021-10-28T08:25:42Z

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

manzt · 2021-10-28T10:39:13Z

Ready to merge

feat: support bigint

b5b3000

typescript-bot added the Check Config Changes a module config files label Oct 3, 2021

typescript-bot added the The CI failed When GH Actions fails label Oct 3, 2021

typescript-bot added The CI failed When GH Actions fails and removed The CI failed When GH Actions fails labels Oct 3, 2021

fix: use type reference comment

2829b62

typescript-bot added The CI failed When GH Actions fails and removed The CI failed When GH Actions fails Check Config Changes a module config files labels Oct 3, 2021

fix: restore default type param for ndarray.DataType

7cf3663

typescript-bot removed the The CI failed When GH Actions fails label Oct 3, 2021

refactor: use conditional types over generics

11cd72e

axelboc suggested changes Oct 4, 2021

View reviewed changes

typescript-bot added the Revision needed This PR needs code changes before it can be merged. label Oct 4, 2021

feat: expanded conditional types for Data

32083ac

typescript-bot added Where is GH Actions? GH Actions didn't give a response to this PR and removed Revision needed This PR needs code changes before it can be merged. labels Oct 5, 2021

axelboc reviewed Oct 5, 2021

View reviewed changes

Comment thread types/ndarray/index.d.ts Outdated

fix: remove unnecessary conditional branch

8e3f868

typescript-bot added Where is GH Actions? GH Actions didn't give a response to this PR and removed Where is GH Actions? GH Actions didn't give a response to this PR labels Oct 5, 2021

axelboc approved these changes Oct 5, 2021

View reviewed changes

typescript-bot added the Owner Approved A listed owner of this package signed off on the pull request. label Oct 5, 2021

fix: prevent tuple type inference, widen types to number[]

aa42981

axelboc reviewed Oct 6, 2021

View reviewed changes

Comment thread types/ndarray/index.d.ts Outdated

infer Value from Record

5333643

axelboc approved these changes Oct 7, 2021

View reviewed changes

typescript-bot added the Owner Approved A listed owner of this package signed off on the pull request. label Oct 7, 2021

typescript-bot added the Unreviewed No one showed up to review this PR, so it'll be reviewed by a DT maintainer. label Oct 18, 2021

rbuckton requested changes Oct 19, 2021

View reviewed changes

typescript-bot added Revision needed This PR needs code changes before it can be merged. and removed Owner Approved A listed owner of this package signed off on the pull request. Unreviewed No one showed up to review this PR, so it'll be reviewed by a DT maintainer. labels Oct 19, 2021

refactor: avoid lib reference in declaration

878b2a7

typescript-bot removed the Revision needed This PR needs code changes before it can be merged. label Oct 20, 2021

axelboc approved these changes Oct 21, 2021

View reviewed changes

typescript-bot added the Owner Approved A listed owner of this package signed off on the pull request. label Oct 21, 2021

orta approved these changes Oct 28, 2021

View reviewed changes

typescript-bot added Maintainer Approved Self Merge This PR can now be self-merged by the PR author or an owner labels Oct 28, 2021

typescript-bot merged commit 46965bc into DefinitelyTyped:master Oct 28, 2021

manzt mentioned this pull request Sep 6, 2022

feat: add (optional) float16 support gzuidhof/zarr.js#129

Merged

SMotaal referenced this pull request in SMotaal/endo Jan 2, 2023

refactor!: add retyped-ses package

261bf0e

SMotaal mentioned this pull request Jan 2, 2023

Node global interfaces redux #62782

Merged

manzt mentioned this pull request Jun 3, 2024

Automatically format JSON and TypeScript ilan-gold/anndata.js#7

Merged

Conversation

manzt commented Oct 3, 2021

Uh oh!

typescript-bot commented Oct 3, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

2 packages in this PR

Code Reviews

Status

Uh oh!

typescript-bot commented Oct 3, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

typescript-bot commented Oct 3, 2021

Uh oh!

typescript-bot commented Oct 3, 2021

Uh oh!

typescript-bot commented Oct 3, 2021

Uh oh!

axelboc Oct 4, 2021

Choose a reason for hiding this comment

Uh oh!

rbuckton Oct 19, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

typescript-bot commented Oct 4, 2021

Uh oh!

Uh oh!

axelboc left a comment

Choose a reason for hiding this comment

Uh oh!

typescript-bot commented Oct 6, 2021

Uh oh!

Uh oh!

typescript-bot commented Oct 7, 2021

Uh oh!

typescript-bot commented Oct 18, 2021

Uh oh!

rbuckton Oct 19, 2021

Choose a reason for hiding this comment

Uh oh!

typescript-bot commented Oct 19, 2021

Uh oh!

manzt commented Oct 20, 2021

Uh oh!

typescript-bot commented Oct 20, 2021

Uh oh!

typescript-bot commented Oct 21, 2021

Uh oh!

orta left a comment

Choose a reason for hiding this comment

Uh oh!

typescript-bot commented Oct 28, 2021

Uh oh!

manzt commented Oct 28, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

typescript-bot commented Oct 3, 2021 •

edited

Loading

typescript-bot commented Oct 3, 2021 •

edited

Loading