oven-sh / bun-types Goto Github PK

View Code? Open in Web Editor NEW

76.0 3.0 11.0 3.44 MB

TypeScript type definitions for Bun's JavaScript runtime APIs

Home Page: https://bun.sh

TypeScript 93.40% JavaScript 6.60%

bun dts javascript nodejs types typescript typescript-definitions

bun-types's Introduction

🚧 Moved to `packages/bun-types` 🚧

These are the type definitions for Bun's JavaScript runtime APIs.

Installation

Install the bun-types npm package:

# yarn/npm/pnpm work too, "bun-types" is an ordinary npm package
bun add bun-types

Usage

Add this to your tsconfig.json or jsconfig.json:

{
  "compilerOptions": {
    "lib": ["ESNext"],
    "module": "esnext",
    "target": "esnext",
    // "bun-types" is the important part
    "types": ["bun-types"]
  }
}

Contributing

bun-types is generated via ./bundle.ts.

Adding a new file

Add it to ./index.d.ts

How to generate types.d.ts

./bundle.ts merges the types in this folder into a single file.

To run it:

bun generate:package

Generated docs

📚 See here for docs

bun-types's People

Contributors

Stargazers

Watchers

Forkers

xhyrom-forks valgaze goodcodedev theabhayprajapati rbargholz jhmaster2000 alii jacob-ebey rohin-chopra johndaly weismanns

bun-types's Issues

Missing `revision` in process.* types

`bun-types`: type declaration of `BufferEncoding` is missing `hex`

Version

0.1.4

Platform

No response

What steps will reproduce the bug?

Install bun-types using bun add bun-types -d
Create a tsconfig.json and index.ts with the following content:

// tsconfig.json
{
    "compilerOptions": {
        "types": [
            "bun-types"
        ]
    }
}

// index.ts
console.log(randomBytes(8).toString('hex'));

Execute the code snippet using bun run index.ts:

How often does it reproduce? Is there a required condition?

Always

What is the expected behavior?

No typescript type error in IDE

What do you see instead?

Console output:

b294075ae26cffa1

The following typescript error:

Argument of type '"hex"' is not assignable to parameter of type 'BufferEncoding'.ts(2345)

Additional information

The implementation exists and works but the type declaration of BufferEncoding is missing hex:
https://github.com/oven-sh/bun/blob/f7e9b91701d60f1f1a319acf799871c20aee007a/types/bun/bun.d.ts#L1218-L1227

`bun-types` is missing `Bun.file().json()` aka `FileBlob.json()`

Version

0.1.5

What steps will reproduce the bug?

[email protected] used to have .json() but as of 0.1.4 it doesn't.

i am on bun 0.1.5 and the function continues to work.

What do you see instead?

Property 'json' does not exist on type 'FileBlob'. ts(2339)

Is `bun-types` BufferEncoding missing 'base64'?

Version

0.1.6 (bun-types 0.1.5)

Platform

Darwin custard 21.6.0 Darwin Kernel Version 21.6.0: Sat Jun 18 17:07:22 PDT 2022; root:xnu-8020.140.41~1/RELEASE_ARM64_T6000 arm64

What steps will reproduce the bug?

passing base64 to Buffer#toString is a type error, but it works (although missing one padding char... maybe that is a bug)

What do you see instead?

A type error

copy readme to dist/

path for bundle.ts is not correct.

The path should be ./scripts/bundle.ts.
instead of ./bundle.ts

oven-sh / bun-types Goto Github PK

bun-types's Introduction

🚧 Moved to packages/bun-types 🚧

Installation

Usage

Contributing

Adding a new file

How to generate types.d.ts

Generated docs

bun-types's People

Contributors

Stargazers

Watchers

Forkers

bun-types's Issues

Version

Platform

What steps will reproduce the bug?

How often does it reproduce? Is there a required condition?

What is the expected behavior?

What do you see instead?

Additional information

Version

What steps will reproduce the bug?

What do you see instead?

Version

Platform

What steps will reproduce the bug?

What do you see instead?

Recommend Projects

Recommend Topics

Recommend Org

🚧 Moved to `packages/bun-types` 🚧