Proof of concept for auto-gen'd docs in markdown, demo here

• [ ] bun run docs to generate types then generate docs based on types in directory api-docs

• [ ] Uses typedoc to focus contributor doc energy on high-value content rather than manually annotating + updating types & parameters

• [ ] Use typedoc.json's publicPath field to set base path for URLs (otherwise falls back to relative prefixed with commit)

• [ ] duplicative tsconfig.docs.json variant since extends appears to be in-flight

• [ ] (not sure) optional "images" folder for embedding fun bun logo or gif, ex ![desc](media://bun.png)

Without publicPath links in repo to specific code appear to have a pathing issue

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

Version

0.1.4

Platform

No response

What steps will reproduce the bug?

1. Install bun-types using bun add bun-types -d
2. 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'));

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

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)

Fix typo-- docs link in main README now points to jekyll (rather than markdown/repo hosting strategy)

@xHyroM is this is a good/stable link? https://oven-sh.github.io/bun-types

Additional changes:

• Updated the generate script on the README as it was wrong: generate -> generate:package
• Fixes to the Prettier and ESLint setup, refer to this commit for details
• Added ArrayBuffer as a valid input type for Bun.write

TODO

• [x] ESLint
• [x] Auto-update version in header
• [x] Label Sync
• [x] Labeler
• [x] Release workflow
• [x] Add github webhook that points to https://i.bun.sh/github_webhook (cc @Jarred-Sumner)
  • https://github.com/xHyroM/bun-discord-bot/commit/4e747f1fd89b632a82f69df65a388800cd8c8f7a
• [x] Remove paths.txt - automate it

Warning I can't push new generated types.d.ts because github throw conflicts (idk why)

Added:

feat: improvements - feat: added eslint - feat: update version in header.txt - fix(url): remove unused import ClientRequestArgs

feat: add labeler and labels fix: add header to labeler, cleanup labels feat: remove paths.txt