Add types for bun.js, a new JavaScript runtime

[Jarred-Sumner]

Bun is a new JavaScript runtime environment, npm package manager, TypeScript & JSX transpiler, JavaScript & CSS bundler, and npm package.json scripts runner all in one incredibly fast CLI.

• 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>.

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.

This does conflict with an existing npm package, however I am one of the collaborators of that npm package. That npm package will eventually be migrated to bun.

The path and fs modules are mostly copied from @types/node. Bun has native implementations of node:fs and node:path that closely mirrors Node's API.

Some of index.d.ts was copied from libdom.d.ts, but I have added more comments where relevant.

I tried to avoid modifying the tslint.json but

• "npm-naming" is disabled because bun doesn't export anything currently, unless I'm misunderstanding?

If there is a way to avoid modifying tslint.json please do say

[typescript-bot]

@Jarred-Sumner 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

• bun (new!) — on npm, on unpkg
  • 1 added owner: ✎@Jarred-Sumner
  • Config files to check:
    • bun/tslint.json: not the expected form (check: rules)

Code Reviews

This PR adds a new definition, so it needs to be reviewed by a DT maintainer 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
• 🕐 Only a DT maintainer can approve changes when there are new packages added

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 31 days — it is considered abandoned, and therefore closed!

---

Diagnostic Information: What the bot saw about this PR

{
  "type": "info",
  "now": "-",
  "pr_number": 59670,
  "author": "Jarred-Sumner",
  "headCommitOid": "28b6bee3cb19d6c7038ec2418efbd27ade99bdf3",
  "mergeBaseOid": "7de5a3274b57a5602670134ef0a36fd4f17fa179",
  "lastPushDate": "2022-04-04T00:42:15.000Z",
  "lastActivityDate": "2022-04-14T20:05:41.000Z",
  "hasMergeConflict": false,
  "isFirstContribution": true,
  "tooManyFiles": false,
  "hugeChange": true,
  "popularityLevel": "Well-liked by everyone",
  "pkgInfo": [
    {
      "name": "bun",
      "kind": "add",
      "files": [
        {
          "path": "types/bun/bun-tests.ts",
          "kind": "test"
        },
        {
          "path": "types/bun/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/bun/tsconfig.json",
          "kind": "package-meta-ok"
        },
        {
          "path": "types/bun/tslint.json",
          "kind": "package-meta",
          "suspect": "not [the expected form](https://github.com/DefinitelyTyped/DefinitelyTyped#user-content-linter-tslintjson) (check: `rules`)"
        }
      ],
      "owners": [],
      "addedOwners": [
        "Jarred-Sumner"
      ],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    }
  ],
  "reviews": [
    {
      "type": "changereq",
      "reviewer": "jakebailey",
      "date": "2022-04-14T20:05:41.000Z"
    }
  ],
  "mainBotCommentID": 1086869775,
  "ciResult": "pass"
}

[typescript-bot]

🔔 @Jarred-Sumner — you're the only owner, but it would still be good if you find someone to review this PR in the next few days, otherwise a maintainer will look at it. (And if you do find someone, maybe even recruit them to be a second owner to make future changes easier...)

[typescript-bot]

@Jarred-Sumner 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]

@Jarred-Sumner 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]

@Jarred-Sumner 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.

[peterblazejewicz]

the project url seems to be wrong (at least for me it gives me 404 on GitHub).
If the project is members only (or any kind of membership/access request), it could be part of source itself, included in documentation, etc.

[Jarred-Sumner]

It is not yet a public repo but it will be soon

Anyone can get access by going to bun.sh/discord, typing “I want Bun” and clicking the GitHub repo invite link the bot generates

[Jarred-Sumner]

@peterblazejewicz what's the next step to get this merged? Sent you an invite to the repo.

If you're not comfortable with merging this until the repository is public, then I can go ahead and make it public.

[peterblazejewicz]

Can you please generate a link for someone here to review the code? thx!

[Jarred-Sumner]

Can you please generate a link for someone here to review the code? thx!

Here you go:

• https://i.bun.sh/still-fog-15696
• https://i.bun.sh/divine-cloud-25397
• https://i.bun.sh/misty-frog-71718
• https://i.bun.sh/jolly-violet-45118
• https://i.bun.sh/tiny-block-44878
• https://i.bun.sh/billowing-feather-20346

Note that roughly none of the types listed here actually correspond to code in JavaScript or TypeScript. Bun is written in Zig and C++, and so are the runtime APIs.

There are examples that use the APIs/types in https://github.com/Jarred-Sumner/bun/tree/main/examples and in https://github.com/Jarred-Sumner/bun/tree/main/integration/bunjs-only-snippets

[jakebailey]

Just for reference, the docs for that dtslint rule is here. The version number check should work because the npm package is 0.0.x, so it must be the export checks like you've noted.

In this case, I think things are getting quite confused thanks to the fact that you're using someone else's existing package name for these types, when that package is still published on npm (not to mention has importers). The same lint override is used in a number of other packages, so that's not unprecedented.

I know enough Zig and C++ to probably review this monstrous PR, but, I do sort of worry about taking over a package like this, especially when these types declare ambient stuff like other runtime-y declarations.

[jakebailey]

What is the plan for that npm package? Is it just going to be deprecated and made empty such that this types package can exist? Or is it going to be where the bun binary is published?

If the latter, you're going to end up having a problem because the types will bring in ambient types even though they're not intended to be used like that.

Perhaps what you need to do is have a package bun-env instead that defines this environment, similar to webpack-env (which works similarly).

---

Regarding the code itself, if you're only intending on having ambient types, then I don't think all of the exports are needed, as there's no actual import one can make directly (as you've noted). The dtslint warning can be silenced by noting that it's a non-npm package, so that's OK.

[typescript-bot]

@Jarred-Sumner 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!

[typescript-bot]

@Jarred-Sumner I haven't seen any activity on this PR in more than three weeks, and it still has problems that prevent it from being merged. The PR will be closed on May 14th (in a week) if the issues aren't addressed.

[typescript-bot]

@Jarred-Sumner To keep things tidy, we have to close PRs that aren't mergeable and don't have activity in the last month. No worries, though — please open a new PR if you'd like to continue with this change. Thank you!