Bun Runtime Compatibility (Unofficial)

[craftingmod]

Bun Runtime Compatibility

matter.js is primarily designed for Node.js, but we've confirmed it also works with Bun runtime in most scenarios.

Important Notes

• Official Support: Node.js LTS 20.x+ only
• Bun Status: Unofficial compatibility - works but not officially tested/supported
• Use at your own risk: We don't guarantee Bun-specific bug fixes or feature support
• Bun version: We recommend Bun v1.3.7 or later.
• Matter.js version: We recommend matter.js v0.16.6 or later.

What Works

• Core Matter protocol functionality
• Device/Bridge/Controller implementations
• @matter/nodejs Environment (automatic runtime detection)
• Most examples and use cases

Known Limitations

Windows: Subpath Import Resolution

• Issue: Subpath imports for scoped packages may fail on Windows
• Status: Fix submitted in bun#26514
• Workaround: Use Linux/macOS or wait for Bun to merge the fix

Getting Started

Installation and usage are simirar to Node.js:

bun install @matter/main

If you haven't installed Node.js, you might need bunfig.toml of your root project to build with

[run]
bun = true

[Apollon77]

@craftingmod Cool summary, maybe we can add that simply as BIN.md in the docs folder ... because from my point of view it is basically "officiall supported" ... we would "Just" need a CI job to automatically test with bun or such ...

[craftingmod]

(I didn't tested all the feature of matter.js in bun)

Current state might be enough :>