API Reference | Bun
Search the reference...
/
This is the complete API reference for Bun, documenting all available APIs, types, and functions. Use the sidebar navigation to browse modules and specific APIs, which are color-coded by type.
This documentation is generated from Bun's TypeScript definitions, which you can find in the oven-sh/bun repository under packages/bun-types.
BunCore runtime APIs for file system, networking, processes, and more.View documentation →bun:bundleAPIs for the bun:bundle module.View documentation →bun:ffiForeign Function Interface for calling native C functions from JavaScript.View documentation →bun:jscLow-level JavaScript Core engine APIs for advanced use cases.View documentation →bun:sqliteBuilt-in SQLite database integration with a simple, performant API.View documentation →bun:testTesting utilities for writing unit and integration tests.View documentation →GlobalsVariables and classes that exist in Bun's global scopeView documentation →node:assertAPIs for the node:assert module.View documentation →node:async_hooksAPIs for the node:async_hooks module.View documentation →node:bufferAPIs for the node:buffer module.View documentation →node:child_processAPIs for the node:child_process module.View documentation →node:clusterAPIs for the node:cluster module.View documentation →node:cryptoAPIs for the node:crypto module.View documentation →node:dgramAPIs for the node:dgram module.View documentation →node:diagnostics_channelAPIs for the node:diagnostics_channel module.View documentation →node:dnsAPIs for the node:dns module.View documentation →node:dns/promisesAPIs for the node:dns/promises module.View documentation →node:eventsAPIs for the node:events module.View documentation →node:fsAPIs for the node:fs module.View documentation →node:fs/promisesAPIs for the node:fs/promises module.View documentation →node:httpAPIs for the node:http module.View documentation →node:http2APIs for the node:http2 module.View documentation →node:httpsAPIs for the node:https module.View documentation →node:inspectorAPIs for the node:inspector module.View documentation →node:inspector/promisesAPIs for the node:inspector/promises module.View documentation →node:moduleAPIs for the node:module module.View documentation →node:netAPIs for the node:net module.View documentation →node:osAPIs for the node:os module.View documentation →node:pathAPIs for the node:path module.View documentation →node:perf_hooksAPIs for the node:perf_hooks module.View documentation →node:punycodeAPIs for the node:punycode module.View documentation →node:querystringAPIs for the node:querystring module.View documentation →node:quicAPIs for the node:quic module.View documentation →node:readlineAPIs for the node:readline module.View documentation →node:readline/promisesAPIs for the node:readline/promises module.View documentation →node:streamAPIs for the node:stream module.View documentation →node:stream/consumersAPIs for the node:stream/consumers module.View documentation →node:stream/iterAPIs for the node:stream/iter module.View documentation →node:stream/promisesAPIs for the node:stream/promises module.View documentation →node:stream/webAPIs for the node:stream/web module.View documentation →node:string_decoderAPIs for the node:string_decoder module.View documentation →node:testAPIs for the node:test module.View documentation →node:test/reportersAPIs for the node:test/reporters module.View documentation →node:timers/promisesAPIs for the node:timers/promises module.View documentation →node:tlsAPIs for the node:tls module.View documentation →node:trace_eventsAPIs for the node:trace_events module.View documentation →node:ttyAPIs for the node:tty module.View documentation →node:urlAPIs for the node:url module.View documentation →node:utilAPIs for the node:util module.View documentation →node:util/typesAPIs for the node:util/types module.View documentation →node:v8APIs for the node:v8 module.View documentation →node:vmAPIs for the node:vm module.View documentation →node:wasiAPIs for the node:wasi module.View documentation →node:worker_threadsAPIs for the node:worker_threads module.View documentation →node:zlibAPIs for the node:zlib module.View documentation →node:zlib/iterAPIs for the node:zlib/iter module.View documentation →Resources
ReferenceDocsGuidesDiscordMerch StoreGitHubBlogToolkit
RuntimePackage managerTest runnerBundlerPackage runnerProject
Bun 1.0Bun 1.1Bun 1.2Bun 1.3RoadmapContributingLicenseBaked with ❤️ in San Francisco
We're hiring →API Reference | Bun,AI智能索引,全网链接索引,智能导航,网页索引
- Complete API reference documentation for Bun